YQueue DocsDevelopers

Schema

Catalog Page Search Request

  • Catalog

Overview

object · 5 properties · 0 required

Properties

page

integer | null
Default 1
Minimum 1
Nullable Yes

per_page

integer | null
Default 25
Minimum 1
Maximum 25
Nullable Yes

sort_field

oneOf
Default uuid
Nullable Yes
One of

One of 1

null

One of 2

reference

References Catalog Sort Field.

sort_direction

oneOf
Default asc
Nullable Yes
One of

One of 1

null

One of 2

reference

References Sort By.

filters

object | null
Nullable Yes
Nested properties

model_types

array | null
Nullable Yes
Unique items Yes
Array items
Items
reference

References Catalog Model Type.

tags

oneOf

UUIDs of tags owned by the merchant.

Nullable Yes
One of
One of 1
null
One of 2
reference

References Catalog UUID List.

query

string | null

The catalog model names to search against.

Min length 1
Max length 255
Nullable Yes

excluded_uuids

array | null

Catalog model UUIDs to exclude from the results.

Nullable Yes
Unique items Yes
Array items
Items
string
Format uuid

Used by

Raw YAML
Download source
title: Catalog Page Search Request
x-tags:
  - Catalog
type: object
properties:
  page:
    type:
      - integer
      - 'null'
    minimum: 1
    default: 1
  per_page:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 25
    default: 25
  sort_field:
    oneOf:
      - type: 'null'
      - $ref: ./CatalogSortField.yaml
    default: uuid
  sort_direction:
    oneOf:
      - type: 'null'
      - $ref: ./SortDirection.yaml
    default: asc
  filters:
    type:
      - object
      - 'null'
    properties:
      model_types:
        type:
          - array
          - 'null'
        uniqueItems: true
        items:
          $ref: ./CatalogModelType.yaml
      tags:
        oneOf:
          - type: 'null'
          - $ref: ./CatalogUuidList.yaml
        description: UUIDs of tags owned by the merchant.
      query:
        type:
          - string
          - 'null'
        minLength: 1
        maxLength: 255
        description: The catalog model names to search against.
      excluded_uuids:
        type:
          - array
          - 'null'
        uniqueItems: true
        items:
          type: string
          format: uuid
        description: Catalog model UUIDs to exclude from the results.

Search documentation

Search across this documentation site.