Skip to main content

CategoryConnection

Category connection wrapper with pagination

categories object[]

List of category records

  • Array [
  • categoryCodestring

    Category code identifier

    descriptionstring

    Category description

    languagestring

    Language code for the description

    codestring

    Alias for categoryCode (for compatibility)

    texts object[]

    Category texts in different languages

  • Array [
  • typestring

    Type of text (e.g., description, shortDescription)

    languageCodestring

    ISO 639-1 language code

    textstring

    Text content

  • ]
  • createdAtstring<date-time>

    Record creation timestamp

    updatedAtstring<date-time>

    Record last update timestamp

  • ]
  • countinteger

    Total number of categories matching the query

    tokenstring

    Pagination token for the next page of results. To retrieve the next page, include this token in the 'token' field of the subsequent request. Tokens are valid for 4 minutes and are tied to the original query criteria. If the query criteria change, a new token must be generated.

    CategoryConnection
    {
    "categories": [
    {
    "categoryCode": "string",
    "description": "string",
    "language": "string",
    "code": "string",
    "texts": [
    {
    "type": "string",
    "languageCode": "string",
    "text": "string"
    }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "count": 0,
    "token": "string"
    }