Get Wishlists

This API is used to retrieve a full list of wishlists.

Query Parameters

• page number

  Default value: 1

  By default first page will be listed. For navigating through pages, use the page parameter.

• limit number

  Default value: 20

  The number of results to return per request.

• id number[]

  Unique identifier of the item.

• slug string[]

  A common or friendly name for the item, should be in lowercase.

• sku string[]

  Stock Keeping Unit value of item, should be unique throughout the item.

• categoryId number[]

  Unique identifier of the category.

• brandId number[]

  Unique identifier of the brand.

• search string

  The query string to be searched for the item.

• zipCode number

  The zip or postal code of the address.

• attributes[color] string

  filter the item based on color.

• attributes[size] string

  filter the item based on size.

• active string

  Possible values: [true, false]

  The current state of the item in wishlist.

  Example: true
• sort[inventories.price] number

  This filter helps to sort the item based on inventory price.

• sort[createdAt] number

  This filter helps to sort the item based on created date.

Responses

• 200

---

Success response

application/json

• Example

---

{
  "statusCode": 200,
  "data": {
    "results": [
      {
        "_id": 352184,
        "categoryId": 34259,
        "description": "",
        "item": {
          "_id": 343468,
          "name": "Penne Pasta"
        },
        "name": "Creamy Garlic Penne Pasta",
        "slug": "creamy-garlic-penne-pasta",
        "inventory": {
          "_id": 363732,
          "locationId": 1364,
          "mrp": 200,
          "price": 180,
          "pricingType": "fixed",
          "taxes": [
            {
              "_id": 1391,
              "active": true,
              "amount": 0,
              "name": "SGST 9%",
              "rate": 9,
              "storeId": 1171,
              "type": "inclusive"
            },
            {
              "_id": 1392,
              "active": true,
              "amount": 0,
              "name": "CGST 9%",
              "rate": 9,
              "storeId": 1171,
              "type": "inclusive"
            }
          ],
          "priceCategories": [],
          "stock": 100,
          "active": true,
          "available": true,
          "deliverable": false
        },
        "category": {
          "_id": 34259,
          "name": "Pasta",
          "slug": "pasta",
          "parentCategories": []
        },
        "attributesGroup": []
      }
    ],
    "pagination": {
      "currentPage": 2,
      "lastPage": 2,
      "perPage": 1,
      "totalResults": 2
    }
  }
}