GOgorest
Shop

List products

get/products

Request

  • Base URL
    https://gorest.co.in/public/v3
  • URL
    https://gorest.co.in/public/v3/products
  • Auth
    • none
    • or HTTP bearer

Query parameters

page[size]integer

Items on one page.

page[after]string

The cursor of the next page, from meta.next_cursor or the Link header. Treat it as opaque; it works only with the same query.

page[number]integer

Offset paging, 1 based, at most 10,000. Cannot be sent with page[after]. Pages can shift while you write.

page[count]boolean

true adds meta.total to a cursor page (it costs a count).

searchstring

Case-insensitive text search over the resource's text fields.

category_idstring uuid
currencystring

filter[category_id]= (one category), filter[currency]=INR (either case). search matches the name, sku and description.

sort'created_at' | '-created_at' | 'name' | '-name' | 'price_minor' | '-price_minor'

One field; a leading - sorts descending. Default -created_at.

productsstring

fields[products]=name,price_minor returns only those fields; included items are added whole.

includestring

Adds related items to each item, one level deep: category. Comma separated.

Headers

If-None-Matchstring

An ETag from an earlier answer; an unchanged item answers 304 with no body.

Response

One page of products.

Example response

{
  "data": [
    {
      "category": {
        "name": "Home and kitchen",
        "slug": "home-kitchen"
      },
      "currency": "INR",
      "name": "Wireless earbuds",
      "price_minor": 249900,
      "sku": "EL-1001"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.