Query parameters

• per_page integer

  Default value is 15.

• page integer

  Default value is 1.

• store_id string(uuid)

  Filter products by store ID

• filter[currency_code] string

  Filter products by currency code

• filter[type] string

  Filter by product type

  Values are price, monetary, or variant.

• filter[is_active] boolean

  Filter by active status

• filter[status] string

  Filter by product visibility status

  Values are public, internal, or link_only.

• filter[categories.id][] array[string(uuid)]

  Filter by category UUIDs

• filter[categories.slug] string

  Filter by category slug

• filter[stores.id][] array[string(uuid)]

  Filter by store UUIDs

• filter[tags][] object

  Filter by custom tags

  Hide filter[tags][] attribute Show filter[tags][] attribute object

  • * string Additional properties
• filter[has_activation_schedule] boolean

  Filter products with scheduled activation

• filter[has_deactivation_schedule] boolean

  Filter products with scheduled deactivation

• sort string

  Sort products by one or more fields. Use '-' prefix for descending order. Available fields: type, name, price, last_purchased, created_at, updated_at Default: -updated_at

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • data array[object]

    Product information for basket and terminal operations

    Hide data attributes Show data attributes object

    • id string(uuid) Required

      Product UUID for basket operations

    • eni string Required

      Entity Number Identifier for basket validation

    • name string Required

      Product display name

    • type string Required

      Product type

      Values are price, monetary, or variant.

    • is_active boolean

      Whether the product is currently active

    • status string

      Product visibility status

      Values are public, internal, or link_only.

    • currency_code string

      Currency code for the product

    • price integer | null

      Fixed price in cents (for price type products)

    • monetary_options object | null

      Configuration for monetary products

      Hide monetary_options attributes Show monetary_options attributes object | null

      • type string

        Values are custom_input or options.

      • inputs object

        Min/max values for custom_input type

        Hide inputs attributes Show inputs attributes object

        • min integer | null
        • max integer | null
      • values array[object]

        Available options for options type

        Hide values attributes Show values attributes object

        • price integer

          Price for this option in cents

        • value integer

          Value of the monetary product in cents

        • label string | null

          Optional display label

    • validity object | null

      Product validity/expiration settings

      Hide validity attributes Show validity attributes object | null

      • type string

        Values are absolute_dates, period_from_purchase, same_day, or no_expiry.

      • values object

        Validity period values

        Hide values attributes Show values attributes object

        • days integer
        • months integer
        • years integer
      • start_date string(date)

        Start date for absolute_dates type

      • end_date string(date)

        End date for absolute_dates type

    • custom_fields object

      Custom fields including required image URLs

      Hide custom_fields attribute Show custom_fields attribute object

      • image_urls array[string(uri)]
    • variants array[object] | null

      Available variants for variant type products

      Hide variants attributes Show variants attributes object

      • id string(uuid)
      • name string
      • price integer

        Variant price in cents

      • validity object

        Override validity for this variant

    • addons array[object]

      Available addons for this product

      Hide addons attributes Show addons attributes object

      • id string(uuid)
      • eni string
      • name string
      • price integer

        Addon price in cents

    • stores array[object]

      Stores where this product is available

      Store information needed for API operations

      Hide stores attributes Show stores attributes object

      • id string(uuid)

        Store UUID

      • subdomain string

        Store subdomain used in Store-Subdomain header

      • name string

        Store display name

      • currency object

        Store currency configuration

        Hide currency attribute Show currency attribute object

        • code string

          Currency code (e.g., usd, gbp, eur)

    • categories array[object]

      Categories this product belongs to

      Hide categories attributes Show categories attributes object

      • id string(uuid)
      • eni string
      • name string
  • meta object
    Hide meta attributes Show meta attributes object

    • current_page integer
    • per_page integer
    • total integer