attribute

attribute.list

Get a list of global attributes.

get/attribute.list.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/attribute.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)

attribute_idsstring

Filter attributes by ids

attribute_set_idstring

Filter items by attribute set id

store_idstring

Store Id

lang_idstring

Retrieves attributes on specified language id

typestring

Defines attribute's type

visibleboolean

Filter items by visibility status

requiredboolean

Defines if the option is required

systemboolean

True if attribute is system

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.