Get Wishlist

GET

{store_url}/api/v1/account/wishlists

Retrieves a paginated list of wishlist items for the customer.
This endpoint supports both private wishlists (authenticated customer) and shared wishlists (via share token).

This endpoint is typically used to:

Display the customer’s wishlist

View a shared wishlist using a share token

Support pagination for large wishlists

Request

Query Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '{store_url}/api/v1/account/wishlists?share_token=abc123xyz&page=1&page_size=24'

Response Example

200 - Example 1

{
    "results": [
        {
            "id": "wl_123",
            "product_class": "crowdfunding_project",
            "sku": "SKU-001",
            "barcode": "1234567890",
            "name": "Wireless Headphones",
            "slug": "wireless-headphones",
            "price": 250,
            "sale_price": 199,
            "formatted_price": "250 SAR",
            "formatted_sale_price": "199 SAR",
            "currency": "SAR",
            "currency_symbol": "ر.س",
            "display_order": 1,
            "images": [
                {
                    "id": "string",
                    "image": {
                        "full_size": "string",
                        "large": "string",
                        "medium": "string",
                        "small": "string",
                        "thumbnail": "string",
                        "property1": "string",
                        "property2": "string"
                    },
                    "alt_text": "string",
                    "display_order": 0,
                    "property1": "string",
                    "property2": "string"
                }
            ],
            "structure": "standalone",
            "created_at": "2026-01-14T07:23:59.944Z",
            "updated_at": "2026-01-14T07:23:59.944Z",
            "quantity": 10,
            "is_infinite": true,
            "badge": "Best Seller",
            "added_at": "2026-01-14T07:23:59.944Z",
            "has_options": true,
            "discount_percentage": 20,
            "in_stock": true,
            "effective_price": 199,
            "main_image": {
                "property1": "string",
                "property2": "string"
            },
            "property1": "string",
            "property2": "string"
        }
    ],
    "count": 12,
    "page": 1,
    "page_size": 24,
    "property1": "string",
    "property2": "string"
}

Modified at 2026-02-23 08:59:30

Get Shareable Wishlist Link

Add Products to Wishlist