Product Attributes
Retrieve available product attribute definitions. Product attributes allow additional data to be captured on products for tracking and reporting.
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/product-attributes |
Get a page of product attributes |
Get Product Attributes Page
Retrieve a paginated list of product attributes.
Endpoint: GET /v1/product-attributes
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PageIndex |
integer | No | Page number (default: 1) |
PageSize |
integer | No | Items per page (default: 25, max: 500) |
SearchText |
string | No | Filter by attribute name |
Request Example
curl -X GET "https://api.consignlyhq.com/v1/product-attributes?PageIndex=1&PageSize=50" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response Example
{
"index": 1,
"total": 6,
"productAttributes": [
{
"id": "550e8400-e29b-41d4-a716-446655449700",
"name": "Color"
},
{
"id": "550e8400-e29b-41d4-a716-446655449701",
"name": "Size"
},
{
"id": "550e8400-e29b-41d4-a716-446655449702",
"name": "Style"
},
{
"id": "550e8400-e29b-41d4-a716-446655449703",
"name": "Grade"
},
{
"id": "550e8400-e29b-41d4-a716-446655449704",
"name": "Country of Origin"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id |
uuid | Product attribute ID |
name |
string | Attribute name |
Related Endpoints
- Partner Products - Product configuration with attributes
- Consignment Import - Create consignments with attributes
- Inventory - Query inventory with attributes