Skip to content
Storefront Services

Get All Products

GET

/products 

https://api.storefront.wdb.skooldio.dev/products

Require Authentication: No

Request Parameters

Query

sort type: string

Field to be sorted and sort order. Possible values of sort order are asc and desc. For example, name:desc

limit type: number

Number of items to return.

startAfter type: string

The ID of the last item in the previous page. (Reference from Firestore Pagination)

categories type: string

Category permalink. If multiple, comma separated.

collection type: string

Collection permalink.

Example Request

Terminal window
curl --request GET \
 --url https://api.storefront.wdb.skooldio.dev/products
Terminal window
curl --request GET \
 --url https://api.storefront.wdb.skooldio.dev/products?categories=category-1
Terminal window
curl --request GET \
 --url https://api.storefront.wdb.skooldio.dev/products?collection=collection-1
Terminal window
curl --request GET \
 --url https://api.storefront.wdb.skooldio.dev/products?collection=collection-1&sort=price:desc

Responses

Results

 
{
  "data": [
    {
      "id": "cwj03UjHZHXkD8Toux0F",
      "name": "Shirt",
      "skuCode": "C01001",
      "permalink": "generic-plain-shirt",
      "price": 100,
      "promotionalPrice": 80,
      "collection": "spring2024",
      "categories": [
        "male",
        "shirts"
      ],
      "ratings": 3.8,
      "imageUrls": [
        "https://firebasestorage.googleapis.com/v0/b/wdb-storefront-project-api.appspot.com/o/products%2Fcwj03UjHZHXkD8Toux0F%2F_images%2FkDhdeZ4V4FRtK89YIveP-DALL%C2%B7E%202024-02-28%2010.36.49%20-%20A%20generic%20shirt%20on%20a%20white%20background%2C%20focusing%20on%20a%20clean%20and%20simple%20design%20to%20emphasize%20the%20shirt's%20shape%20and%20details.%20The%20shirt%20should%20appear%20neatl.webp?alt=media&token=b1feee9d-f763-4291-acec-2f2bb6473e78"
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "nextCursor": null
  }
}