Products

Product management operations

Get all products

get

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products

Retrieves a list of all products.

Authorizations

cookieAuth

accessTokenstringRequired

Query parameters

limitintegerOptional

The number of products to return.

Default: 10

offsetintegerOptional

The number of products to skip.

Default: 0

Responses

200

A list of products.

application/json

401

Unauthorized.

get

/products

HTTPcURLJavaScriptPython

GET /api/v1/products HTTP/1.1
Host: localhost:3000
Accept: */*

{
  "limit": 1,
  "offset": 1,
  "total": 1,
  "products": [
    {
      "_id": "text",
      "name": "text",
      "description": "text",
      "slug": "text",
      "price": 1,
      "discountedPrice": 1,
      "stock": 1,
      "category": "text",
      "brand": "text",
      "images": [
        {
          "publicId": "text",
          "url": "text",
          "width": 1,
          "height": 1
        }
      ],
      "ratings": {
        "average": 1,
        "count": 1
      },
      "isFeatured": true,
      "retailer": "text",
      "likesCount": 1,
      "commentsCount": 1,
      "createdAt": "2025-12-08T22:16:16.896Z",
      "updatedAt": "2025-12-08T22:16:16.896Z"
    }
  ]
}

Create a new product

post

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products

Creates a new product (retailer only).

Authorizations

cookieAuth

accessTokenstringRequired

Body

multipart/form-data

namestringOptional

descriptionstringOptional

pricenumberOptional

discountedPricenumberOptional

stockintegerOptional

categoryIdstringOptional

brandstringOptional

isFeaturedbooleanOptional

product_imagesstring · binary[]Optional

Responses

201

Product created successfully.

application/json

400

Bad request (e.g., invalid input).

401

Unauthorized.

403

Forbidden.

post

/products

HTTPcURLJavaScriptPython

POST /api/v1/products HTTP/1.1
Host: localhost:3000
Content-Type: multipart/form-data
Accept: */*
Content-Length: 157

{
  "name": "text",
  "description": "text",
  "price": 1,
  "discountedPrice": 1,
  "stock": 1,
  "categoryId": "text",
  "brand": "text",
  "isFeatured": true,
  "product_images": [
    "binary"
  ]
}

{
  "_id": "text",
  "name": "text",
  "description": "text",
  "slug": "text",
  "price": 1,
  "discountedPrice": 1,
  "stock": 1,
  "category": "text",
  "brand": "text",
  "images": [
    {
      "publicId": "text",
      "url": "text",
      "width": 1,
      "height": 1
    }
  ],
  "ratings": {
    "average": 1,
    "count": 1
  },
  "isFeatured": true,
  "retailer": "text",
  "likesCount": 1,
  "commentsCount": 1,
  "createdAt": "2025-12-08T22:16:16.896Z",
  "updatedAt": "2025-12-08T22:16:16.896Z"
}

Get product by slug

get

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products/{slug}

Retrieves a product by its slug.

Authorizations

cookieAuth

accessTokenstringRequired

Path parameters

slugstringRequired

The slug of the product to retrieve.

Responses

200

The product's information.

application/json

401

Unauthorized.

404

Not found.

get

/products/{slug}

HTTPcURLJavaScriptPython

GET /api/v1/products/{slug} HTTP/1.1
Host: localhost:3000
Accept: */*

{
  "_id": "text",
  "name": "text",
  "description": "text",
  "slug": "text",
  "price": 1,
  "discountedPrice": 1,
  "stock": 1,
  "category": "text",
  "brand": "text",
  "images": [
    {
      "publicId": "text",
      "url": "text",
      "width": 1,
      "height": 1
    }
  ],
  "ratings": {
    "average": 1,
    "count": 1
  },
  "isFeatured": true,
  "retailer": "text",
  "likesCount": 1,
  "commentsCount": 1,
  "createdAt": "2025-12-08T22:16:16.896Z",
  "updatedAt": "2025-12-08T22:16:16.896Z"
}

Update a product

put

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products/{productId}

Updates a product by its ID (retailer only).

Authorizations

cookieAuth

accessTokenstringRequired

Path parameters

productIdstringRequired

The ID of the product to update.

Body

multipart/form-data

namestringOptional

descriptionstringOptional

pricenumberOptional

discountedPricenumberOptional

stockintegerOptional

categoryIdstringOptional

brandstringOptional

isFeaturedbooleanOptional

product_imagesstring · binary[]Optional

Responses

200

Product updated successfully.

application/json

400

Bad request (e.g., invalid input).

401

Unauthorized.

403

Forbidden.

404

Not found.

put

/products/{productId}

HTTPcURLJavaScriptPython

PUT /api/v1/products/{productId} HTTP/1.1
Host: localhost:3000
Content-Type: multipart/form-data
Accept: */*
Content-Length: 157

{
  "name": "text",
  "description": "text",
  "price": 1,
  "discountedPrice": 1,
  "stock": 1,
  "categoryId": "text",
  "brand": "text",
  "isFeatured": true,
  "product_images": [
    "binary"
  ]
}

{
  "_id": "text",
  "name": "text",
  "description": "text",
  "slug": "text",
  "price": 1,
  "discountedPrice": 1,
  "stock": 1,
  "category": "text",
  "brand": "text",
  "images": [
    {
      "publicId": "text",
      "url": "text",
      "width": 1,
      "height": 1
    }
  ],
  "ratings": {
    "average": 1,
    "count": 1
  },
  "isFeatured": true,
  "retailer": "text",
  "likesCount": 1,
  "commentsCount": 1,
  "createdAt": "2025-12-08T22:16:16.896Z",
  "updatedAt": "2025-12-08T22:16:16.896Z"
}

Delete a product

delete

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products/{productId}

Deletes a product by its ID (retailer or admin only).

Authorizations

cookieAuth

accessTokenstringRequired

Path parameters

productIdstringRequired

The ID of the product to delete.

Responses

204

Product deleted successfully.

401

Unauthorized.

403

Forbidden.

404

Not found.

delete

/products/{productId}

HTTPcURLJavaScriptPython

DELETE /api/v1/products/{productId} HTTP/1.1
Host: localhost:3000
Accept: */*

No content

Get products by retailer

get

http://localhost:3000/api/v1https://e-commerce-api.deephiwase.xyz/api/v1

/products/retailer/{retailerId}

Retrieves a list of products for a specific retailer.

Authorizations

cookieAuth

accessTokenstringRequired

Path parameters

retailerIdstringRequired

The ID of the retailer.

Query parameters

limitintegerOptional

The number of products to return.

Default: 10

offsetintegerOptional

The number of products to skip.

Default: 0

Responses

200

A list of products.

application/json

401

Unauthorized.

404

Not found.

get

/products/retailer/{retailerId}

HTTPcURLJavaScriptPython

GET /api/v1/products/retailer/{retailerId} HTTP/1.1
Host: localhost:3000
Accept: */*

{
  "limit": 1,
  "offset": 1,
  "total": 1,
  "products": [
    {
      "_id": "text",
      "name": "text",
      "description": "text",
      "slug": "text",
      "price": 1,
      "discountedPrice": 1,
      "stock": 1,
      "category": "text",
      "brand": "text",
      "images": [
        {
          "publicId": "text",
          "url": "text",
          "width": 1,
          "height": 1
        }
      ],
      "ratings": {
        "average": 1,
        "count": 1
      },
      "isFeatured": true,
      "retailer": "text",
      "likesCount": 1,
      "commentsCount": 1,
      "createdAt": "2025-12-08T22:16:16.896Z",
      "updatedAt": "2025-12-08T22:16:16.896Z"
    }
  ]
}