Alerts

Stock and price alert subscriptions

List stock alerts

get

Retrieves active stock availability alerts created by the shopper.

Query parameters

pageinteger · min: 1Optional

Page number (1-indexed)

Example: 1

page_sizeinteger · min: 1Optional

Number of results per page

Example: 20

searchintegerOptional

Filter alerts by product identifier

Example: 123456

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

Product alerts listed

application/json

countintegerRequiredExample: 3

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

previousstring · nullableOptional

401

Authentication required

application/json

get/wishlists/product-alerts/

HTTPcURLJavaScriptPython

GET /wishlists/product-alerts/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Accept: */*

{
  "count": 3,
  "next": "https://sandbox.akinon.com/wishlists/product-alerts/?page=2",
  "previous": null,
  "results": [
    {
      "pk": 84,
      "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"
          }
        ]
      }
    }
  ]
}

Subscribe to stock alert

post

Creates a stock availability alert for the given product.

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 monitor for restock events

Example: 221133

Responses

201

Alert created

application/json

Stock alert subscription

pkintegerRequiredExample: 84

400

Request payload validation error

application/json

401

Authentication required

application/json

409

Alert already exists

post/wishlists/product-alerts/

HTTPcURLJavaScriptPython

POST /wishlists/product-alerts/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "product": 221133
}

{
  "pk": 84,
  "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"
      }
    ]
  }
}

Cancel stock alert

delete

Path parameters

pkintegerRequired

Alert 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

Alert removed

No content

401

Authentication required

application/json

404

Alert not found

delete/wishlists/product-alerts/{pk}/

HTTPcURLJavaScriptPython

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

No content

List price alerts

get

Retrieves price-drop alerts configured by the shopper.

Query parameters

pageinteger · min: 1Optional

Page number (1-indexed)

Example: 1

page_sizeinteger · min: 1Optional

Number of results per page

Example: 20

searchintegerOptional

Filter alerts by product identifier

Example: 123456

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

Price alerts listed

application/json

countintegerRequiredExample: 2

nextstring · nullableOptional

previousstring · nullableOptional

401

Authentication required

application/json

get/wishlists/price-alerts/

HTTPcURLJavaScriptPython

GET /wishlists/price-alerts/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Accept: */*

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 99,
      "product": 221133
    }
  ]
}

Create or update price alert

post

Creates a new price alert or updates the existing one for the same product.

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

pkintegerOptional

Existing alert identifier (send to update)

Example: 99

productintegerRequired

Product identifier to monitor for price changes

Example: 221133

Responses

201

Price alert saved

application/json

Price alert subscription

pkintegerRequiredExample: 99

productintegerRequired

Linked product identifier

Example: 221133

400

Request payload validation error

application/json

401

Authentication required

application/json

post/wishlists/price-alerts/

HTTPcURLJavaScriptPython

POST /wishlists/price-alerts/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "pk": 99,
  "product": 221133
}

{
  "pk": 99,
  "product": 221133
}