Add products to wishlist

This endpoint allows the user to add products to their wishlist. Once added, the response returns the updated wishlist, including all previously saved products and the newly added one(s).

Request

Header Params

Accept-Language

string

optional

Preferred language for the response. Defaults to en if not specified.

Example:

Content-Type

string

optional

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Example:

application/json

Role

string

optional

Role of the user.

Example:

CUSTOMER

store-id

string

optional

Unique identifier of the store.

Example:

662

x-customer-token

string

optional

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.

Example:

eyJpdiI6IjliNGQxU3JUUzBzeTljTmtwUmR1RGc9PSIsInZhbHVlIjoiaWx4b0tzVWV1RnVWcUUrUGZWSmF5SXRkZFRCdmZUQnBvcHZEWDE1cENmajJCVldENFUrVW9kSnRwaURLcWd6UGJPT0NTK09RQkEyQnRoQkY2Zk5xLzZNL1B2WUlHYUgrcjkza3h1UVJDWVVzNXJzZXN2TkFqZE1YSVBYUWZNZi9QS25aeWgxRW95U1pnVjNzblJ4OVpvSUN6c05VdHI1dXRKdi8wdDVOYTRtekcwK3NZakc4elAwRjRCaDZyOEpBIiwibWFjIjoiODY0MmI1MDY5ZDFjOTQ5ZmNkNzAyNjMyN2ZmYTllZWNkMjRiZmU1NGIxMzg2ODhlYThiMDRiY2NkZWRjMzUxYSIsInRhZyI6IiJ9

Body Params text/plain

Example

Example:{ "products": [ "b6c52f8d-0ffc-4355-873b-a36ea40a76ac" ] }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

count

integer

required

The total number of products in the wishlist.

Example:

null

required

The URL to the next page of results, if available. If no more pages exist, this will be null.

null

required

The URL to the previous page of results, if available. If no previous page exists, this will be null.

results

array [object {44}]

required

An array containing details about each product in the wishlist.

string

required

The unique identifier of the product.

Example:

0e3d9b24-986c-4ce1-914e-445448421b83

product_class

null

required

The classification of the product, if applicable.

sku

string

required

The SKU (Stock Keeping Unit) of the product.

Example:

Z.662.16245276488091216

barcode

string

required

The barcode of the product, if available.

parent_id

null

required

The identifier for the parent product, if the product is part of a group or bundle.

name

string

required

The name of the product.

Example:

mobile

slug

string

required

The SEO-friendly URL slug for the product.

Example:

mobile

price

integer

required

The base price of the product.

Example:

100

short_description

string | null

required

A brief description of the product.

sale_price

null

required

The discounted price of the product, if applicable.

formatted_price

string

required

The formatted base price of the product, including the currency symbol.

Example:

100.00 ر.س

formatted_sale_price

null

required

The formatted sale price of the product, if available.

currency

string

required

The currency code in which the product price is listed (e.g., "SAR").

Example:

SAR

currency_symbol

string

required

The symbol of the currency used (e.g., "ر.س").

Example:

ر.س

attributes

array[string]

required

A list of product attributes, such as size or color.

meta

null

required

Extra metadata for the product.

related_products_settings

string

required

Settings for how related products are displayed (e.g., "AUTO_GENERATED").

Example:

AUTO_GENERATED

related_products_title

null

required

The title for related products.

badge

null

required

Any badge associated with the product (e.g., "New Arrival").

group_products

null

required

Information about grouped products, if applicable.

stocks

array [object {4}]

required

Stock details for the product, including location and available quantity.

sold_products_count

null

required

The total number of products sold.

created_at

string

required

The date and time when the product was created.

Example:

2021-06-24T09:40:48.823387Z

updated_at

string

required

The date and time when the product was last updated.

Example:

2024-08-11T09:32:03.964248Z

added_at

string

required

The date and time when the product was added to the wishlist.

Example:

2024-09-24T18:14:22.645461Z

Example

{
  "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"
    }
  ]
}