Catalog
- GETRetrieve all products
- POSTCreate product
- GETRetrieve skus
- GETRetrieve product details
- PUTUpdate product details
- DELDelete product
- GETRetrieve product variants
- POSTCreate variant
- POSTUpdate variants in bulk
- GETRetrieve a variant details
- PUTUpdate a variant
- DELDelete a variant
- GETRetrieve product inventory
- POSTUpdate product inventory
- GETRetrieve product inventory activities
- PUTUpdate product inventory activities
- POSTCreate product inventory activities
- GETRetrieve product reviews
- GETRetrieve product review
- PUTUpdate product review
- DELDelete product review
- GETRetrieve all categories
- POSTCreate category
- GETRetrieve category
- PUTUpdate category
- DELDelete category
- GETRetrieve all attributes
- POSTCreate attribute
- GETRetrieve attribute
- PUTUpdate attribute
- DELDelete attribute
- POSTAdd product pricing
- PUTUpdate product pricing
- DELDelete product pricing
- POSTAdd product image
- PUTUpdate product image
- DELDelete product image
- GETRetrive sku detail
Auth
- PUTActivate user account
- PUTDeactivate user account
- GETCheck domain availability
- GETRetrieve all roles
- POSTCreate new role
- PUTUpdate role
- DELDelete role
- GETRetrieve all permissions of a role
- POSTAdd permission to role
- DELRemove permission from role
- GETRetrieve all members
- POSTCreate new member
- GETRetrieve member detail
- PUTUpdate member details
- DELDelete member
- GETRetrieve all roles of a member
- POSTAssigne role to member
- DELRemove role from member
Coupons & promotions API
- GETList all coupons
- POSTCreate coupon
- GETRetrieve coupon details
- PUTUpdate coupon
- DELDelete coupon
- GETList all coupon codes
- POSTAdd coupon code
- GETList all coupon customers
- GETRetrieve coupon usage
- GETList all promotions
- POSTCreate promotion
- GETRetrieve promotion details
- PUTUpdate promotion
- DELDelete promotion
- GETList all promotion usage
- GETList all promotion customers
Warehouse
Orders API
Shipping API
Customers API
Segments API
Payments API
Media Gallery API
Catalog
Retrieve attribute
GET
/
catalog
/
attributes
/
{id}
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/attributes/{id} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"attribute": {
"id": "<string>",
"name": "<string>",
"attribute_type": "Text",
"default_value": "<string>",
"is_visible": true,
"is_filterable": true,
"is_required": true,
"is_localized": true,
"active": true,
"product_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"products": [
{
"id": "<string>",
"name": "<string>",
"status": "draft",
"active": true,
"stock_available": true,
"short_description": "<string>",
"metadata": [
{
"name": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"product_type": "<string>",
"hsn_code": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>",
"active": true
}
],
"attributes": [
{
"attribute_id": "<string>",
"attribute_name": "<string>",
"attribute_value": "<string>",
"attribute_type": "Text"
}
],
"variant_options": [
{
"option_name": "<string>",
"option_value": [
"<string>"
]
}
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"is_featured": true,
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"has_variant": true,
"variant_count": 123,
"modified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"images": [
{
"id": 123,
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"other_details": {}
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": "<any>",
"limit": 123,
"next_page": "<any>"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
attribute Ulid
Response
200 - application/json
OK
Maximum length:
128
Available options:
Text
, Number
, Boolean
, Date
, Single-select
, Multi-select
, Color
, Currency
, File
, Image
attribute ulid
Maximum length:
128
product ulid
Maximum length:
128
Maximum length:
256
Maximum length:
32
Maximum length:
64
Available options:
draft
, active
, inactive
Available options:
Text
, Number
, Boolean
, Date
, Single-select
, Multi-select
, Color
, Currency
, File
, Image
Maximum length:
128
Maximum length:
128
Maximum length:
512
Maximum length:
512
Maximum length:
512
Maximum length:
512
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/attributes/{id} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"attribute": {
"id": "<string>",
"name": "<string>",
"attribute_type": "Text",
"default_value": "<string>",
"is_visible": true,
"is_filterable": true,
"is_required": true,
"is_localized": true,
"active": true,
"product_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"products": [
{
"id": "<string>",
"name": "<string>",
"status": "draft",
"active": true,
"stock_available": true,
"short_description": "<string>",
"metadata": [
{
"name": "<string>",
"value": "<string>"
}
],
"tags": [
"<string>"
],
"product_type": "<string>",
"hsn_code": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>",
"active": true
}
],
"attributes": [
{
"attribute_id": "<string>",
"attribute_name": "<string>",
"attribute_value": "<string>",
"attribute_type": "Text"
}
],
"variant_options": [
{
"option_name": "<string>",
"option_value": [
"<string>"
]
}
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"is_featured": true,
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"has_variant": true,
"variant_count": 123,
"modified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"images": [
{
"id": 123,
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"other_details": {}
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": "<any>",
"limit": 123,
"next_page": "<any>"
}
}
}