For the complete documentation index, see llms.txt. This page is also available as Markdown.

Wishlists

Customer favourite products

List favourite products

get
/wishlists/favourite-products/

Returns the customer's favourite products with merchandising metadata.

Query parameters
pageinteger · min: 1Optional

Page number (1-indexed)

Example: 1
page_sizeinteger · min: 1Optional

Number of results per page

Example: 20
product_idinteger[]Optional

Filter favourites by product identifier (repeatable)

searchintegerOptional

Filter favourites by exact product identifier

Example: 9876
base_code__instringOptional

Filter favourites by product base codes (comma separated)

Example: ABC123,XYZ999
product__namestringOptional

Filter favourites by product name (case insensitive contains)

Example: smartwatch
Header parameters
X-CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses
200

Favourite products listed

application/json
countintegerRequiredExample: 5
nextstring · nullableOptionalExample: https://sandbox.akinon.com/wishlists/favourite-products/?page=2
previousstring · nullableOptional
get/wishlists/favourite-products/
GET /wishlists/favourite-products/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: text
Accept: */*
{
  "count": 5,
  "next": "https://sandbox.akinon.com/wishlists/favourite-products/?page=2",
  "previous": null,
  "results": [
    {
      "pk": 42,
      "product": {
        "pk": 221133,
        "name": "Smart Watch X",
        "sku": "SW-X-BLACK",
        "base_code": "SWX",
        "price": "1999.00",
        "retail_price": "2499.00",
        "currency_type": "TRY",
        "in_stock": true,
        "stock": 12,
        "absolute_url": "https://sandbox.akinon.com/product/smart-watch-x/",
        "productimage_set": [
          {
            "pk": 4455,
            "image": "https://cdn.akinon.com/images/products/smart-watch-x.png",
            "order": null,
            "specialimage_set": [
              {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ]
          }
        ],
        "productvideo_set": [
          {
            "pk": 1,
            "video": "https://example.com"
          }
        ],
        "is_ready_to_basket": true,
        "extra_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "basket_offers": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "price_type": "default",
        "tax_rate": "18.00",
        "price_extra_field": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

Add product to favourites

post
/wishlists/favourite-products/

Stores the given product in the authenticated shopper's favourites.

Header parameters
X-CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Body
productintegerRequired

Product identifier to favourite

Example: 221133
Responses
201

Favourite created

application/json

Favourite product entry

pkintegerRequiredExample: 42
post/wishlists/favourite-products/
POST /wishlists/favourite-products/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "product": 221133
}
{
  "pk": 42,
  "product": {
    "pk": 221133,
    "name": "Smart Watch X",
    "sku": "SW-X-BLACK",
    "base_code": "SWX",
    "price": "1999.00",
    "retail_price": "2499.00",
    "currency_type": "TRY",
    "in_stock": true,
    "stock": 12,
    "absolute_url": "https://sandbox.akinon.com/product/smart-watch-x/",
    "productimage_set": [
      {
        "pk": 4455,
        "image": "https://cdn.akinon.com/images/products/smart-watch-x.png",
        "order": null,
        "specialimage_set": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video": "https://example.com"
      }
    ],
    "is_ready_to_basket": true,
    "extra_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "basket_offers": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "price_type": "default",
    "tax_rate": "18.00",
    "price_extra_field": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Check which products are favourited

get
/wishlists/favourite-product-ids/

Lightweight favourite check for product listing pages. Given a set of repeatable product_id query parameters, returns the ones favourited by the authenticated shopper, each paired with the wishlist item id (favourite_id) required to remove it from favourites via deleteFavouriteProduct.

Unlike listFavouriteProducts, this endpoint performs a single database query and returns only identifiers — no product cards, pricing, stock, or media are serialized. It is intended for storefront listing / infinite-scroll views that need to render the "favourited" state of many products at once (and offer a remove action) without the cost of the full favourites payload.

Behaviour notes:

  • Invalid (non-integer) product_id values are silently ignored.

  • When no valid product_id is supplied, an empty list is returned.

  • When SKU-level favourites are disabled (FAVOURITE_SKU_IS_ACTIVE=false), a product is reported as favourited if the shopper has favourited any product sharing its base_code, and favourite_id points at that existing base_code favourite.

Query parameters
product_idinteger[]Optional

Product identifiers to check for favourited state (repeatable)

Example: [600993,78179,853075]
Header parameters
X-CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses
200

Favourited products resolved

application/json

Favourited entries among the queried products. Each entry pairs the queried product_id with the wishlist item id (favourite_id) needed to remove it from favourites via deleteFavouriteProduct.

get/wishlists/favourite-product-ids/
GET /wishlists/favourite-product-ids/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: text
Accept: */*
{
  "favourite_products": [
    {
      "product_id": 600993,
      "favourite_id": 42
    }
  ]
}

Remove product from favourites

delete
/wishlists/favourite-products/{pk}/
Path parameters
pkintegerRequired

Favourite identifier

Header parameters
X-CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses
204

Favourite removed

No content

delete/wishlists/favourite-products/{pk}/
DELETE /wishlists/favourite-products/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: text
Accept: */*

No content

Last updated

Was this helpful?