GET
/partner-api/brandsQuery brands
Explore the query brands endpoint, including request parameters and response details.
Parameters
2 parametersallbooleanoptionalIf specified return all brands (for lookup)
qstringoptionalJSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.
DECODED QUERY FIELDS
q.where.originalNameobjectMatch the original brand name, for example {"iLike":"%example%"}.
q.where.orarrayCombine alternative brand conditions, such as originalName or englishName.
q.paginationobjectPagination: current page and pageSize; defaults are 1 and 20.
EXAMPLE BEFORE ENCODING
{
"where": {
"or": [
{
"originalName": {
"iLike": "%example%"
}
},
{
"englishName": {
"iLike": "%example%"
}
}
]
},
"pagination": {
"current": 1,
"pageSize": 10
}
}Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.
Responses
Successful responses200OK
responsepartnerBrandsResponseoptionaldatapartnerBrandsResponseItem[]optionalbrandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionalpaginationpaginationoptionaltotalintegeroptionalTotal number of records (unpaginated) based on the query criteria.
pageSizeintegeroptionalPage size. Default page size is applied if not specified. Maximum 100.
currentintegeroptionalCurrent page starting from 1.
NOTHINGPHISHY API REFERENCE
