Search sales items available within given category

post

https://virtserver.swaggerhub.com/catalogue/v1/category/{categoryId}/item/search/{page}

Search for sales item existing below category with given categoryId

Response Code	Fault Code	Fault	Suggested User Message
500	90061	SystemFailureFault	System Failure, please try again later
400	7003	BadInputException	Catagogy Id must be Provided
400	7004	BadInputException	Category Id must be numeric
400	7001	BadInputException	Currency is null or empty
400	7002	BadInputException	Item type is invalid
400	7009	BadInputException	Invalid currency code

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

page

integer

required

The specific page of results to retrieve

categoryId

int64

required

The id of the category for which subcategories will be retrieved

Query Params

pagesize

integer

5 to 50

Defaults to 20

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

activeFilter

string

enum

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

Allowed:

orderBy

string

Field and direction to order results. Available fields are name (item name) and date (last updated date). Ordering may be asc (ascending) or desc (descending)

limited

boolean

Defaults to true

Flag indicating to only retrieve items got a specific category (not including sub-categories). If set to false will retrieve recursively items from the category and all its subcategories

searchId

string

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

Body Params

The details to use for searching

Details used for searching category items

currency

string

required

length ≤ 3

3 character currency code used to provide correct price

itemType

string

enum

Limits category items to one type

Allowed:

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

200Success

400Bad request