List a retail product's variation axes

GET/v2/experiences/{experienceId}/retail-attributes

Requires your API key in the X-API-Key header.

Returns the product's variation axes (Colour, Size, ...) in sortOrder, each with its values. A product without variations has no axes and sells from a single SKU. An unknown experience, or one that is not a retail product, returns an empty list.

Requestbash
curl "https://api.turneo.co/v2/experiences/8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f/retail-attributes" \
  -H "X-API-Key: <your-api-key>"

Path parameters

  • experienceIdstring (uuid)required

    UUID of the retail product (an experience with experienceType RETAIL or VOUCHER).

    Example:
    8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f

Query parameters

  • pageinteger

    Page number to return (1-based).

    Default:
    1
    Example:
    1
  • page_sizeinteger

    Number of axes per page (default 50).

    Default:
    50
    Example:
    50
  • nopaginationboolean

    When true, disables pagination and returns all axes in a plain array.

    Example:
    false

Responses

200object

Paginated list of variation axes.

  • countinteger

    Total number of axes.

    Example:
    2
  • nextstring (uri)nullable

    URL of the next page, or null on the last page.

  • previousstring (uri)nullable

    URL of the previous page, or null on the first page.

  • resultsobject[]

    Variation axes on this page.

    Child fields
    • idstring (uuid)

      Axis UUID.

      Example:
      2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e
    • namestring or map of string

      Multilingual text field. Stored as an object keyed by language code (en, de, it, es, fr, hr, sl, pt, zh, zh-hant, ja, ko, ru; machine translations are stored under <lang>_auto keys internally). On read it is returned as a single string resolved for the requested language (falling back to English when the object is not consistently translated), or as the full per-language object when showTranslations=true is passed. On write, either a plain string (stored as English) or a partial per-language object is accepted.

      Accepted shapes
      • Either string

      • Or map of string

    • sortOrderinteger

      Position of the axis among the product's axes.

      Example:
      0
    • valuesobject[]

      The axis's values, in sortOrder.

      Child fields
      • idstring (uuid)

        Value UUID. SKUs list the values they are made of in attributeValueIds.

        Example:
        9a8b7c6d-5e4f-4a3b-8c1d-0e9f8a7b6c5d
      • labelstring or map of string

        Multilingual text field. Stored as an object keyed by language code (en, de, it, es, fr, hr, sl, pt, zh, zh-hant, ja, ko, ru; machine translations are stored under <lang>_auto keys internally). On read it is returned as a single string resolved for the requested language (falling back to English when the object is not consistently translated), or as the full per-language object when showTranslations=true is passed. On write, either a plain string (stored as English) or a partial per-language object is accepted.

        Accepted shapes
        • Either string

        • Or map of string

      • sortOrderinteger

        Position of the value within its axis.

        Example:
        0
Response 200json
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "name": "Sunset Kayak Tour",
      "sortOrder": 0,
      "values": [
        {
          "id": "9a8b7c6d-5e4f-4a3b-8c1d-0e9f8a7b6c5d",
          "label": "Sunset Kayak Tour",
          "sortOrder": 0
        }
      ]
    }
  ]
}

Errors

401

Missing or invalid X-API-Key header.

Error body
  • typestring

    Error class.

    Allowed values:
    validation_errorclient_errorserver_error
    Example:
    validation_error
  • errorsobject[]
    Child fields
    • codestring

      Machine-readable error code.

      Example:
      required
    • fieldstringnullable

      Offending field, or null/'general' for non-field errors.

      Example:
      startTime
    • messagestring

      Human-readable message.

      Example:
      This field is required.
Response 401json
{
  "type": "validation_error",
  "errors": [
    {
      "code": "required",
      "field": "startTime",
      "message": "This field is required."
    }
  ]
}