Wishlists

Customer favourite products

List favourite products

get

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

Use X-Cookie header instead of Cookie header in "try out" section. Use Cookie header while testing in postman or other tools. Some commerce applications may support 'sesionid' instead of 'osessionid'.

Example: osessionid=abc123

Responses

200

Favourite products listed

application/json

countintegerRequiredExample: 5

nextstring · nullableOptionalExample: https://sandbox.akinon.com/wishlists/favourite-products/?page=2

previousstring · nullableOptional

401

Authentication required

application/json

get/wishlists/favourite-products/

HTTPcURLJavaScriptPython

GET /wishlists/favourite-products/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
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"
          }
        ]
      }
    }
  ]
}

Add product to favourites

post

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

Header parameters

X-CookiestringRequired

Use X-Cookie header instead of Cookie header in "try out" section. Use Cookie header while testing in postman or other tools. Some commerce applications may support 'sesionid' instead of 'osessionid'.

Example: osessionid=abc123

Body

application/json

productintegerRequired

Product identifier to favourite

Example: 221133

Responses

201

Favourite created

application/json

Favourite product entry

pkintegerRequiredExample: 42

400

Request payload validation error

application/json

401

Authentication required

application/json

409

Product already exists in favourites

post/wishlists/favourite-products/

HTTPcURLJavaScriptPython

POST /wishlists/favourite-products/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
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"
      }
    ]
  }
}

Remove product from favourites

delete

Path parameters

pkintegerRequired

Favourite identifier

Header parameters

X-CookiestringRequired

Use X-Cookie header instead of Cookie header in "try out" section. Use Cookie header while testing in postman or other tools. Some commerce applications may support 'sesionid' instead of 'osessionid'.

Example: osessionid=abc123

Responses

204

Favourite removed

No content

401

Authentication required

application/json

404

Favourite not found

delete/wishlists/favourite-products/{pk}/

HTTPcURLJavaScriptPython

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

No content