Collections

Authenticated customer collections

List customer collections

get

Returns the authenticated shopper's collections with nested items.

Query parameters

pageinteger · min: 1Optional

Page number (1-indexed)

Example: 1

page_sizeinteger · min: 1Optional

Number of results per page

Example: 20

product_idintegerOptional

Filter collections that include the specified product

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

Collections listed

application/json

401

Authentication required

application/json

get

/wishlists/user-collections/

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 12,
      "name": "Summer Essentials",
      "status": "private",
      "slug": "summer-essentials",
      "items": [
        {
          "pk": 345,
          "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"
              }
            ]
          },
          "created_date": "2025-10-30T09:45:00Z",
          "note": "Remember to check new colours"
        }
      ],
      "public_url": "https://sandbox.akinon.com/wishlists/user-collection/summer-essentials/"
    }
  ]
}

Create a new collection

post

Creates a named collection owned by the authenticated shopper.

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

namestring · max: 255Required

Human readable collection name

Example: Summer Essentials

statusstring · enumOptional

Collection visibility

Example: privatePossible values:

Responses

201

Collection created

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

post

/wishlists/user-collections/

HTTPcURLJavaScriptPython

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

{
  "name": "Summer Essentials",
  "status": "private"
}

{
  "pk": 12,
  "name": "Summer Essentials",
  "status": "private",
  "slug": "summer-essentials",
  "items": [
    {
      "pk": 345,
      "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"
          }
        ]
      },
      "created_date": "2025-10-30T09:45:00Z",
      "note": "Remember to check new colours"
    }
  ],
  "public_url": "https://sandbox.akinon.com/wishlists/user-collection/summer-essentials/"
}

Retrieve collection

get

Path parameters

pkintegerRequired

Collection 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

200

Collection detail

application/json

401

Authentication required

application/json

404

Collection not found

get

/wishlists/user-collections/{pk}/

HTTPcURLJavaScriptPython

GET /wishlists/user-collections/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Accept: */*

{
  "pk": 12,
  "name": "Summer Essentials",
  "status": "private",
  "slug": "summer-essentials",
  "items": [
    {
      "pk": 345,
      "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"
          }
        ]
      },
      "created_date": "2025-10-30T09:45:00Z",
      "note": "Remember to check new colours"
    }
  ],
  "public_url": "https://sandbox.akinon.com/wishlists/user-collection/summer-essentials/"
}

Replace collection

put

Path parameters

pkintegerRequired

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

namestring · max: 255OptionalExample: Updated Collection Name

statusstring · enumOptional

Collection visibility

Example: privatePossible values:

Responses

200

Collection updated

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

404

Collection not found

put

/wishlists/user-collections/{pk}/

HTTPcURLJavaScriptPython

PUT /wishlists/user-collections/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "Updated Collection Name",
  "status": "private"
}

{
  "pk": 12,
  "name": "Summer Essentials",
  "status": "private",
  "slug": "summer-essentials",
  "items": [
    {
      "pk": 345,
      "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"
          }
        ]
      },
      "created_date": "2025-10-30T09:45:00Z",
      "note": "Remember to check new colours"
    }
  ],
  "public_url": "https://sandbox.akinon.com/wishlists/user-collection/summer-essentials/"
}

Delete collection

delete

Path parameters

pkintegerRequired

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

Collection deleted

401

Authentication required

application/json

404

Collection not found

delete

/wishlists/user-collections/{pk}/

HTTPcURLJavaScriptPython

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

No content

Partially update collection

patch

Path parameters

pkintegerRequired

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

namestring · max: 255OptionalExample: Updated Collection Name

statusstring · enumOptional

Collection visibility

Example: privatePossible values:

Responses

200

Collection updated

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

404

Collection not found

patch

/wishlists/user-collections/{pk}/

HTTPcURLJavaScriptPython

PATCH /wishlists/user-collections/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "Updated Collection Name",
  "status": "private"
}

{
  "pk": 12,
  "name": "Summer Essentials",
  "status": "private",
  "slug": "summer-essentials",
  "items": [
    {
      "pk": 345,
      "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"
          }
        ]
      },
      "created_date": "2025-10-30T09:45:00Z",
      "note": "Remember to check new colours"
    }
  ],
  "public_url": "https://sandbox.akinon.com/wishlists/user-collection/summer-essentials/"
}

Add product to collection

post

Appends a product to the specified collection.

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

usercollection_idintegerRequired

Owning collection identifier

Example: 12

product_idintegerRequired

Product identifier to add

Example: 221133

notestring · max: 255Optional

Optional shopper note

Example: Gift idea for Mom

Responses

201

Collection item created

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

403

Collection ownership mismatch

post

/wishlists/user-collection-items/

HTTPcURLJavaScriptPython

POST /wishlists/user-collection-items/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "usercollection_id": 12,
  "product_id": 221133,
  "note": "Gift idea for Mom"
}

{
  "pk": 345,
  "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"
      }
    ]
  },
  "created_date": "2025-10-30T09:45:00Z",
  "note": "Remember to check new colours"
}

Replace collection item

put

Path parameters

pkintegerRequired

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

notestring · max: 255Required

Updated note text

Example: Purchased during summer sale

Responses

200

Item updated

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

404

Item not found

put

/wishlists/user-collection-items/{pk}/

HTTPcURLJavaScriptPython

PUT /wishlists/user-collection-items/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "note": "Purchased during summer sale"
}

{
  "pk": 345,
  "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"
      }
    ]
  },
  "created_date": "2025-10-30T09:45:00Z",
  "note": "Remember to check new colours"
}

Remove collection item

delete

Path parameters

pkintegerRequired

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

Item deleted

401

Authentication required

application/json

404

Item not found

delete

/wishlists/user-collection-items/{pk}/

HTTPcURLJavaScriptPython

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

No content

Partially update collection item

patch

Path parameters

pkintegerRequired

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

notestring · max: 255Required

Updated note text

Example: Purchased during summer sale

Responses

200

Item updated

application/json

400

Request payload validation error

application/json

401

Authentication required

application/json

404

Item not found

patch

/wishlists/user-collection-items/{pk}/

HTTPcURLJavaScriptPython

PATCH /wishlists/user-collection-items/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
X-Cookie: osessionid=abc123
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "note": "Purchased during summer sale"
}

{
  "pk": 345,
  "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"
      }
    ]
  },
  "created_date": "2025-10-30T09:45:00Z",
  "note": "Remember to check new colours"
}