Retrieve All Catalog Items

Retrieves all the items saved under a merchant's catalog.

📘

Note: Authentication Token, Active Team and Enabled Team Required.

Retrieves all the items saved under a merchant's catalog. The items may be searched using keywords, such as keywords[]=red, to find specific items. The items may also be filtered and sorted.

Sort Parameters

ParameterDescription
nameSorts the items alphabetically by name.
codeSorts by item code numerically.
descriptionSorts items alphabetically by description.
priceSorts the items numerically by price.
quantitySorts the items numerically by quantity.
is_serviceSorts the items between those that are a service and those that aren't.
is_activeSorts items into active and inactive categories.
is_taxableSorts the items between those that are taxable and those that aren't.
is_discountSorts items into those on discount and those not on discount.
created_atSorts chronologically based on the times items were created.
updated_atSorts chronologically based on the last time items were updated.

Order Parameters

ParameterDescription
DESCDisplays results in a descending order.
ASCDisplays results in an ascending order.

Query Params
string

Filter by items of the exact code

float

Filters by items of the exact price.

string

Filters by items of the exact quantity.

boolean

Filters for services.

boolean

Filters for active items.

boolean

Filters for taxable items.

boolean

Filters if the item is discounted or not.

string

Filters by user id.

string

Filters out any items that don't share the inputted name. Does not have to be exact.

string

Filters by part of description.

string

Filters by meta. Does not have to be exact.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json