get product list (public)

Developing

GET

products

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'products?page&per_page&category_id&min_price&max_price' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
  "pagination": {
    "current_page": 1,
    "pages": 1,
    "per_page": 20,
    "total": 7
  },
  "products": [
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 1,
      "name": "updated product",
      "price": 50.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['updated-eco-friendly', 'updated-handmade']",
      "vendor_id": 7
    },
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 2,
      "name": "Cheap item",
      "price": 5.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['cheap', 'handmade']",
      "vendor_id": 7
    },
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 3,
      "name": "Cheap item",
      "price": 5.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['cheap', 'handmade']",
      "vendor_id": 2
    },
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 4,
      "name": "Cheap item",
      "price": 5.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['cheap', 'handmade']",
      "vendor_id": 2
    },
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 5,
      "name": "Cheap item",
      "price": 5.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['cheap', 'handmade']",
      "vendor_id": 2
    },
    {
      "average_rating": 0.0,
      "category_id": null,
      "id": 6,
      "name": "Cheap item",
      "price": 5.0,
      "primary_image_url": null,
      "review_count": 0,
      "tags": "['cheap', 'handmade']",
      "vendor_id": 2
    },
    {
      "average_rating": 4.5,
      "category_id": 1,
      "id": 8,
      "name": "updated product",
      "price": 25.99,
      "primary_image_url": "https://example.com/primary-image.jpg",
      "review_count": 2,
      "tags": "['updated-eco-friendly', 'updated-handmade']",
      "vendor_id": 17
    }
  ],
  "success": true
}

Request

Query Params

page

string

optional

per_page

string

optional

category_id

string

optional

min_price

string

optional

max_price

string

optional

Responses

🟢200Success

application/json

Body

pagination

object

required

current_page

integer

required

pages

integer

required

per_page

integer

required

total

integer

required

products

array [object {9}]

required

average_rating

integer | number

required

category_id

integer | null

required

integer

required

name

string

required

price

integer | number

required

primary_image_url

string | null

required

review_count

integer

required