GET
/
catalog
/
products
curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/products \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

page number of pagination list

Required range: x > 1
limit
integer

no of rows per page

Required range: x > 1
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"}

search keyword

filters
string

JSON - array of objects

active
boolean

active flag

Response

200
application/json
OK
message
string
success
boolean
content
object