Skip to main content

Query updates

POST 
/updates/query

Search and filter updates (news items). Updates are informational items published by organizations — for example, product announcements, company news, or promotional content.

There are two types of updates:

  • automatic — generated by the platform when certain events occur (e.g. a new product is created).
  • manual — created by organization managers through the platform UI.

Manual updates may have associated entities (products, brands, or categories) depending on their sub-type.

Filter​

The optional filter object supports the following filters:

  • id — match by update ID (string).
  • organization — match by organization ID (string or array of strings).
  • type — match by type: automatic or manual (string or array of strings).
  • subType — match by sub-type: product, organization, public_category, or brand (string or array of strings).
  • locale — match by locale (string or array of strings).
  • product — match by associated product ID (string or array of strings).
  • publicCategory — match by associated public category ID (string or array of strings).
  • brand — match by associated brand ID (string or array of strings).
  • targetGroup — match by target group (string or array of strings).
  • createdAt — filter by creation date range, with from and/or until (unix timestamps).
  • touchedAt — filter by last-modified date range, with from and/or until (unix timestamps).
  • search — full-text search with query (string) and locale (string).
  • and — match all of the given filters.
  • or — match any of the given filters.
  • not — negate a filter.

Sorting​

The optional sorting object accepts a single sortable field:

  • id — sort by update ID.
  • createdAt — sort by creation date.
  • sortOrder — sort by the platform's default ordering.

The value is the sort direction: asc or desc.

Pagination​

Use the page object to paginate results. If omitted, all results are returned.

Request​

Responses​

Successful operation