Skip to content
extensions / Commerce extension
POST/__runtime/wishlist/items

Create Wishlist Item

Adds a product or variant to the current shopper's storefront wishlist.

POST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Requires an authenticated storefront session or a guest wishlist cookie.

Headers

NameRequiredTypeDetails
CookieYesNot specified
Description: Value used by this operation.
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.
User-AgentYesNot specified
Description: Value used by this operation.

Path Parameters

Query Parameters

Request Body

Schema: RuntimeWishlistItemRequest

FieldRequiredTypeDetails
project_idYesinteger
Description: Target project identifier.
product_idYesinteger
Description: Target product identifier.
variant_idNointeger
Description: Identifier for variant.
variant_skuNostring
Description: Text value.
variant_labelNostring
Description: Human-readable label.
variant_attributesNoJSON
Description: JSON object.
product_item_codeNostring
Description: Text value.

Response Body

Example 200 response

json
{
  "items": [],
  "item_keys": [],
  "entries": [],
  "total": 1,
  "selected": true,
  "html": "string"
}

Errors

400 BAD_REQUEST500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified