Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://admin.aeoliancms.com/api/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "products": [
    {
      "id": "<string>",
      "storeId": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "status": "<string>",
      "description": "<string>",
      "metaTitle": "<string>",
      "metaDescription": "<string>",
      "images": [
        {
          "url": "<string>",
          "alt": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "options": [
        {
          "id": "<string>",
          "name": "<string>",
          "displayStyle": "dropdown",
          "position": 123,
          "values": [
            {
              "id": "<string>",
              "value": "<string>",
              "position": 123
            }
          ]
        }
      ],
      "variants": [
        {
          "id": "<string>",
          "price": "<string>",
          "compareAtPrice": "<string>",
          "stockQuantity": 123,
          "stockStatus": "<string>",
          "image": {
            "url": "<string>",
            "alt": "<string>"
          },
          "attributes": {}
        }
      ],
      "collections": [
        {
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

API key in format ak_<48-hex-chars>

Query Parameters

limit
integer
default:100
Required range: 1 <= x <= 500
offset
integer
default:0
paginated
boolean
default:false

Include pagination metadata

lightweight
boolean
default:false

Return minimal product data (id, name, slug, images, tags, price)

Response

List of products

products
object[]
pagination
object