product

product.brand.list

Get list of brands from your store.

get/product.brand.list.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/product.brand.list.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

startinteger

This parameter sets the number from which you want to get entities

countinteger

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

page_cursorstring

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

brand_idsstring

Retrieves brands specified by brand ids

category_idstring

Retrieves product brands specified by category id

parent_idstring

Retrieves brands specified by parent id

store_idstring

Store Id

lang_idstring

Language id

find_wherestring

Entity search that is specified by the comma-separated unique fields

find_valuestring

Entity search that is specified by some value

created_fromstring

Retrieve entities from their creation date

created_tostring

Retrieve entities to their creation date

modified_fromstring

Retrieve entities from their modification date

modified_tostring

Retrieve entities to their modification date

availboolean

Defines category's visibility status

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

excludestring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.