Skip to content

Wishlist Endpoint

TIP

Refer to products page for Base URL

* Add Product To Wishlist

Endpoint: POST

products/wishlist/

Request Headers

AuthorizationValueDescriptionRequired
Bearer***************Firebase access token✔️

Payload Description

NameTypeDescriptionRequired
productSlugstringproduct slug✔️

Sample Payload

{
  "productSlug": "just-another-product-name-8237"
}

Sample Response

"product added"

* Remove Product From Wishlist

Endpoint: DELETE

products/wishlist/product_slug

Request Headers

AuthorizationValueDescriptionRequired
Bearer***************Firebase access token✔️

Parameters

NameTypeDescriptionRequired
product_slugstringproduct slug✔️

Sample Request

products/wishlist/just-another-product-name-8237

Sample Response

{
  "status": "204 No Content",
}

* User Wishlist Products

Endpoint: GET

products/wishlist/user/

Request Headers

AuthorizationValueDescriptionRequired
Bearer***************Firebase access token✔️

Parameters

Not Required

Sample Response

[
  {
    "id": "8c0003e6-8eb6-4d15-b87f-b962e3f59329",
    "images": [
        "http://127.0.0.1:8000/media/products/2023%20-%2001/2.jpg",
        "http://127.0.0.1:8000/media/products/2023%20-%2001/1.jpg"
    ],
    "inStock": true,
    "name": "shirt",
    "originalPrice": "4564.00",
    "salePrice": "34.00",
    "slug": "shirt-4665",
    "store": {
      "id": "269e7656-f23b-46ad-83d7-46b5f5504dd6"
    },
    "mainCategory": "Women",
    "starRating": "0.0",
    "sizes": ["L", "XL"],
    "colors": [
      {
        "name": "Black",
        "code": "#000000"
      },
      {
        "name": "White",
        "code": "#FFFFFF"
      }
    ],
    "brand": "Chow Tai Fook"
  }
]

* Wishlist Instance

Helps to verify if a user has added product to wishlist or not.

Endpoint: GET

products/wishlist-instance/product_slug

Request Headers

AuthorizationValueDescriptionRequired
Bearer***************Firebase access token✔️

Parameters

NameTypeDescriptionRequired
product_slugstringproduct slug✔️

Sample Request

products/wishlist-instance/just-another-product-name-8237

Sample Response

[
  {
    "id": "263abc22-5254-4624-9328-5d27568479a4",
    "userId": "dfwervty34vqxct44df3ycfv",
    "productId": "8c0003e6-8eb6-4d15-b87f-b962e3f59329"
  }
]

Released under the MIT License.