Skip to main content

CategoriesResponse

categories object
categories object[]
  • 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>
    updatedAtstring<date-time>
  • ]
  • countinteger
    tokenstring

    Continuation token emitted when more categories exist than the server page size. CategoriesRequest has no token or maxSize field today — clients cannot page by echoing this value. Prefer filtering with query.connectionCode / query.categoryCodes so the result fits in one response.

    errors object[]
  • Array [
  • codestring
    typestring

    Possible values: [CLIENT, SERVER]

    descriptionstring
  • ]
  • CategoriesResponse
    {
    "categories": {
    "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"
    },
    "errors": [
    {
    "code": "string",
    "type": "CLIENT",
    "description": "string"
    }
    ]
    }