NOTHINGPHISHY
GET/partner-api/brands

Query brands

Explore the query brands endpoint, including request parameters and response details.

Parameters

2 parameters
allbooleanoptional

If specified return all brands (for lookup)

qstringoptional

JSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.

DECODED QUERY FIELDS
q.where.originalNameobject

Match the original brand name, for example {"iLike":"%example%"}.

q.where.orarray

Combine alternative brand conditions, such as originalName or englishName.

q.paginationobject

Pagination: 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 responses
200OK
responsepartnerBrandsResponseoptional
datapartnerBrandsResponseItem[]optional
brandIdintegeroptional
originalNamestringoptional

Brand name in its original language.

englishNamestringoptional
paginationpaginationoptional
totalintegeroptional

Total number of records (unpaginated) based on the query criteria.

pageSizeintegeroptional

Page size. Default page size is applied if not specified. Maximum 100.

currentintegeroptional

Current page starting from 1.

NOTHINGPHISHY API REFERENCE