Get Product Attributes

Retrieves the list of all product attributes of the org.

Some attributes like price, item_sku, description, img_url would be common across organizations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Parameters

ParameterDatatypeDescription
namestringName of the attribute.
labelstringLabel name of the attribute
is\_enumenumWhether the attribute values are predefined values. 1 if enum type, 0 if not enum.
typestringDatatype of the attribute value.
default\_attribute\_value\_namestringDefault value of the attribute if any.
inventory\_item\_attributesstringName of the table (in the database) from which the attributes are retrieved.
ou\_idintegerIndicates the ID of the OU. -1 indicates that the product belongs to a master org. This is applicable only if OU support for product inventory is enabled.
Query Params
boolean

Retrieves category ids of each product attribute size fetched.

boolean

Pass true to retrieve all child attributes.

int32

Limits number of child attributes to be retrieved per attribute.

string

Retrieves details of an an attribute based on the attribute name (name is not case sensitive).

int64

Pass an attribute id to fetch the details of that specific attribute.

int32

Limits the number of results to be retrieved.

int32

Entries to be ignored from the top.

string

Identifier code of the organisation.

string
enum

ALL - Fetches details of product associated with both master org and org unit. ORG-Fetches details of products associated with master ORG. SCOPE-Fetches details of products associated with an org unit.

Allowed:
Responses

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