Delete Items from Wishlist - Spree Commerce documentation

Community

Github

API basics

Tutorials

Quick Checkout with Stripe and Storefront API

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Stripe
Products
Vendors
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
Wishlists / Wished Items
- POST
  Add Item to Wishlist
- POST
  Add Items to Wishlist
- PATCH
  Set Wished Item Quantity
- DEL
  Delete Item from Wishlist
- DEL
  Delete Items from Wishlist
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Vendors
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

DELETE

api

storefront

wishlists

{token}

remove_items

curl --request DELETE \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists/{token}/remove_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "wished_items_ids": [
    "1",
    "2"
  ]
}'

{
  "data": {
    "id": "28",
    "type": "wishlist",
    "attributes": {
      "token": "1inBHcJnxBrVEMAZb9esRqZP",
      "name": "My Wishlist",
      "is_private": false,
      "is_default": true,
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": [
          {
            "id": "14",
            "type": "wished_item"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Path Parameters

token

string

required

The token is a unique string used to identify the target resource.

Body

application/vnd.api+json

wished_items_ids

string[]

The Wished Item ID that is to be removed from wishlist.

Response

200

application/vnd.api+json

200 Success - Returns the `wishlist` object.

data

object

required

included

object[]

Was this page helpful?

Suggest edits Raise issue

Download a Digital AssetThis endpoint allows you to download a digital item using the unique digital_link token. The digital_link token value can be found by including `line_items.digital_links` in a completed order lookup. Use the **Retrieve an Order Status** endpoint found under the Order Status tab, or the **Retrieve an Order** endpoint found under the Account / Orders tab to perform a completed order lookup. Depending on the store that the item was purchased in, downloads may be restricted to a set number of days since the purchase was made. Additionally, the number of times a download link can be used may be restricted. If you are not authorized to perform the download due to the download limit restrictions mentioned above, a 403 response will be returned.

curl --request DELETE \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists/{token}/remove_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "wished_items_ids": [
    "1",
    "2"
  ]
}'

{
  "data": {
    "id": "28",
    "type": "wishlist",
    "attributes": {
      "token": "1inBHcJnxBrVEMAZb9esRqZP",
      "name": "My Wishlist",
      "is_private": false,
      "is_default": true,
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": [
          {
            "id": "14",
            "type": "wished_item"
          }
        ]
      }
    }
  }
}