Search content items

post

https://virtserver.swaggerhub.com/products/v1/content/search/{page}

Search for content items matching given criteria. Case insensitive partial matching is done on criteria. Results matching all criteria are returned.

Response Code	Fault Code	Fault	Suggested User Message
tbc	tbc	New API created for 1.5	tbc

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

page

integer

required

The specific page of results to retrieve

Query Params

pagesize

integer

5 to 100

Defaults to 20

The number of results to show on a single page. Value should be between 5 and 100 inclusive. If not supplied or not valid, defaults to 20

activeFilter

string

enum

If not supplied, only active items will be returned. If supplied, specifies whether to return only active, only inactive, or all items.

Allowed:

orderBy

string

Field and direction to order results

searchId

string

Used for matching search requests and responses where clients may be making multiple concurrent requests

Body Params

The details to use to search for content items

Details to use to search for content items

type

string

enum

The type of this content item, restricts how this item can be sold

Allowed:

code

string

length ≤ 20

The content item code for this item

name

string

length ≤ 40

A more descriptive name for this item

providerId

integer

The ID for any provider associated with this item. Must match one of the provider IDs returned from the provider search endpoint.

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

enum

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Allowed:

Responses

Language

Loading…

Response

Choose an example:

application/json

200Search request successful.

400Bad request