Get Wishlist
DevelopingGETv1/customer/wishlist/This endpoint retrieves the list of products saved by the customer in their wishlist. It returns detailed information about each product, including pricing, availability, and ratings, helping merchants track which products are favored by their customers.
Request
Preferred language for the response. Defaults to en if not specified.
The Media Type of the body of the request. This is used to describe the structure of the data in the body.
Role of the user.
Unique identifier of the store.
The X-CUSTOMER-TOKEN is a unique identifier generated when a customer logs in through the customer-login API. This token acts as the standard authorization mechanism, allowing the system to recognize the logged-in customer and grant them access to appropriate resources.
Request samples
Responses
The total number of products in the wishlist.
The URL to the next page of results, if available. If no more pages exist, this will be null.
The URL to the previous page of results, if available. If no previous page exists, this will be null.
An array containing details about each product in the wishlist.
The unique identifier of the product.
The classification of the product, if applicable.
The SKU (Stock Keeping Unit) of the product.
The barcode of the product, if available.
The identifier for the parent product, if the product is part of a group or bundle.
The name of the product.
The SEO-friendly URL slug for the product.
The base price of the product.
A brief description of the product.
The discounted price of the product, if applicable.
The formatted base price of the product, including the currency symbol.
The formatted sale price of the product, if available.
The currency code in which the product price is listed (e.g., "SAR").
The symbol of the currency used (e.g., "ر.س").
A list of product attributes, such as size or color.
A list of categories that the product belongs to.
The order in which the product is displayed.
Indicates whether the product has selectable options (e.g., color or size).
Indicates whether the product has customizable fields.
A list of images associated with the product, including different sizes and URLs.
Indicates whether the product is in draft status.
The available stock quantity of the product.
Indicates whether the product has unlimited stock availability.
The URL for the product's page on the website.
The weight of the product, including value (float) and unit (string).
A list of keywords associated with the product for SEO purposes.
Indicates whether the product requires shipping.
Indicates whether the product is taxable.
The structure type of the product (e.g., "standalone").
SEO-related information for the product, including title and description.
The product's rating information, including average (float), total_count (integer), and detailed breakdown of ratings by star level (1–5 stars).
The identifier of the store that owns the product.
Information about any purchase restrictions, such as minimum/maximum quantities per cart.
Additional metadata related to the product.
Extra metadata for the product.
Settings for how related products are displayed (e.g., "AUTO_GENERATED").
The title for related products.
Any badge associated with the product (e.g., "New Arrival").
Information about grouped products, if applicable.
Stock details for the product, including location and available quantity.
The total number of products sold.
The date and time when the product was created.
The date and time when the product was last updated.
The date and time when the product was added to the wishlist.
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "0e3d9b24-986c-4ce1-914e-445448421b83",
"product_class": null,
"sku": "Z.662.16245276488091216",
"barcode": "",
"parent_id": null,
"name": "mobile ",
"slug": "mobile",
"price": 100,
"short_description": null,
"sale_price": null,
"formatted_price": "100.00 ر.س ",
"formatted_sale_price": null,
"currency": "SAR",
"currency_symbol": " ر.س ",
"attributes": [],
"categories": [],
"display_order": null,
"has_options": false,
"has_fields": false,
"images": [],
"is_draft": false,
"quantity": null,
"is_infinite": true,
"html_url": "https://sorry.zidtest.com/products/mobile",
"weight": {
"value": null,
"unit": "kg"
},
"keywords": [],
"requires_shipping": true,
"is_taxable": true,
"structure": "standalone",
"seo": {
"title": "mobile ",
"description": ""
},
"rating": {
"average": 0,
"total_count": 0,
"1_ratings": {
"percentage": 0,
"count": 0
},
"2_ratings": {
"percentage": 0,
"count": 0
},
"3_ratings": {
"percentage": 0,
"count": 0
},
"4_ratings": {
"percentage": 0,
"count": 0
},
"5_ratings": {
"percentage": 0,
"count": 0
}
},
"store_id": 662,
"purchase_restrictions": {
"min_quantity_per_cart": null,
"max_quantity_per_cart": null,
"availability_period_start": null,
"availability_period_end": null,
"sale_price_period_start": null,
"sale_price_period_end": null
},
"metafields": null,
"meta": null,
"related_products_settings": "AUTO_GENERATED",
"related_products_title": null,
"badge": null,
"group_products": null,
"stocks": [
{
"id": "1d4e08bd-0353-4b6d-92b7-3f521105cfb6",
"location": {
"id": "c374e682-5c15-4c27-bdcf-2c544cb8c8bb",
"name": "Default - الافتراضي",
"type": "PHYSICAL",
"full_address": "test"
},
"available_quantity": null,
"is_infinite": true
}
],
"sold_products_count": null,
"created_at": "2021-06-24T09:40:48.823387Z",
"updated_at": "2024-08-11T09:32:03.964248Z",
"added_at": "2024-09-24T18:14:22.645461Z"
},
{
"id": "4c8834cb-d765-4cd0-a58b-97183383fece",
"product_class": null,
"sku": "Z.662.1624432301572608",
"barcode": "",
"parent_id": null,
"name": "Product 1",
"slug": "no-shiping",
"price": 300,
"short_description": "<span></span>",
"sale_price": null,
"formatted_price": "300.00 ر.س ",
"formatted_sale_price": null,
"currency": "SAR",
"currency_symbol": " ر.س ",
"attributes": [],
"categories": [],
"display_order": null,
"has_options": false,
"has_fields": false,
"images": [
{
"id": "f8713556-fa95-4e59-8f2a-6cdf092bdb4c",
"image": {
"medium": "https://test-media-907587157081.zid.store/thumbs/3183f757-6687-4499-9487-ed47910ab9d0/f8713556-fa95-4e59-8f2a-6cdf092bdb4c-thumbnail-770x770-70.jpg",
"small": "https://test-media-907587157081.zid.store/thumbs/3183f757-6687-4499-9487-ed47910ab9d0/f8713556-fa95-4e59-8f2a-6cdf092bdb4c-thumbnail-500x500-70.jpg",
"large": "https://test-media-907587157081.zid.store/thumbs/3183f757-6687-4499-9487-ed47910ab9d0/f8713556-fa95-4e59-8f2a-6cdf092bdb4c-thumbnail-1000x1000-70.jpg",
"thumbnail": "https://test-media-907587157081.zid.store/thumbs/3183f757-6687-4499-9487-ed47910ab9d0/f8713556-fa95-4e59-8f2a-6cdf092bdb4c-thumbnail-370x370-70.jpg",
"full_size": "https://test-media-907587157081.zid.store/3183f757-6687-4499-9487-ed47910ab9d0/f8713556-fa95-4e59-8f2a-6cdf092bdb4c.jpg"
},
"alt_text": null,
"display_order": 0
}
],
"is_draft": false,
"quantity": 2,
"is_infinite": false,
"html_url": "https://sorry.zidtest.com/products/no-shiping",
"weight": {
"value": null,
"unit": "kg"
},
"keywords": [],
"requires_shipping": true,
"is_taxable": true,
"structure": "standalone",
"seo": {
"title": "No shiping",
"description": ""
},
"rating": {
"average": 2,
"total_count": 1,
"1_ratings": {
"percentage": 0,
"count": 0
},
"2_ratings": {
"percentage": 100,
"count": 1
},
"3_ratings": {
"percentage": 0,
"count": 0
},
"4_ratings": {
"percentage": 0,
"count": 0
},
"5_ratings": {
"percentage": 0,
"count": 0
}
},
"store_id": 662,
"purchase_restrictions": {
"min_quantity_per_cart": null,
"max_quantity_per_cart": null,
"availability_period_start": null,
"availability_period_end": null,
"sale_price_period_start": null,
"sale_price_period_end": null
},
"metafields": null,
"meta": null,
"related_products_settings": "AUTO_GENERATED",
"related_products_title": null,
"badge": null,
"group_products": null,
"stocks": [
{
"id": "c7a058f0-0522-4144-aea6-a67c1106debd",
"location": {
"id": "c374e682-5c15-4c27-bdcf-2c544cb8c8bb",
"name": "Default - الافتراضي",
"type": "PHYSICAL",
"full_address": "test"
},
"available_quantity": 2,
"is_infinite": false
}
],
"sold_products_count": null,
"created_at": "2021-06-23T07:11:41.580122Z",
"updated_at": "2024-10-06T12:14:10.031094Z",
"added_at": "2024-09-24T18:14:25.206904Z"
}
]
}