Claim guest wishlists after login
curl --request POST \
--url https://{host}/api/v1/guest-wishlists/claim \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <api-key>' \
--header 'X-Shopify-SessionId: <api-key>' \
--header 'X-Shopify-Shop: <api-key>'const options = {
method: 'POST',
headers: {
'X-Shopify-ApiKey': '<api-key>',
'X-Shopify-Shop': '<api-key>',
'X-Shopify-CustomerId': '<api-key>',
'X-Shopify-SessionId': '<api-key>'
}
};
fetch('https://{host}/api/v1/guest-wishlists/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/guest-wishlists/claim"
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"X-Shopify-SessionId": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)import Foundation
let url = URL(string: "https://{host}/api/v1/guest-wishlists/claim")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"X-Shopify-SessionId": "<api-key>"
]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val request = Request.Builder()
.url("https://{host}/api/v1/guest-wishlists/claim")
.post(null)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.addHeader("X-Shopify-SessionId", "<api-key>")
.build()
val response = client.newCall(request).execute(){
"data": {
"migrated": true
},
"message": "Your saved wishlists are now in your account",
"messageKey": "success_guest_wishlists_claimed"
}{
"title": "Unauthenticated",
"status": 401,
"code": "UNAUTHENTICATED",
"message": "Invalid API Key",
"messageKey": null
}{
"title": "Guest disabled",
"status": 403,
"code": "GUEST_DISABLED",
"message": "Please log in to save items to your wishlist.",
"messageKey": "error_guest_login_required"
}{
"title": "Version retired",
"status": 410,
"code": "VERSION_RETIRED",
"message": "Please update the app to continue.",
"messageKey": "error_app_update_required"
}{
"title": "Rate limited",
"status": 429,
"code": "RATE_LIMITED",
"message": "Too many requests. Please try again in a minute.",
"messageKey": "error_too_many_requests"
}{
"title": "Internal error",
"status": 500,
"code": "INTERNAL_ERROR",
"message": "Something went wrong. Please try again.",
"messageKey": "error_something_went_wrong"
}Account
Claim guest wishlists after login
Send BOTH X-Shopify-CustomerId and X-Shopify-SessionId. No body. Safe to repeat.
POST
/
guest-wishlists
/
claim
Claim guest wishlists after login
curl --request POST \
--url https://{host}/api/v1/guest-wishlists/claim \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <api-key>' \
--header 'X-Shopify-SessionId: <api-key>' \
--header 'X-Shopify-Shop: <api-key>'const options = {
method: 'POST',
headers: {
'X-Shopify-ApiKey': '<api-key>',
'X-Shopify-Shop': '<api-key>',
'X-Shopify-CustomerId': '<api-key>',
'X-Shopify-SessionId': '<api-key>'
}
};
fetch('https://{host}/api/v1/guest-wishlists/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/guest-wishlists/claim"
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"X-Shopify-SessionId": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)import Foundation
let url = URL(string: "https://{host}/api/v1/guest-wishlists/claim")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"X-Shopify-SessionId": "<api-key>"
]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val request = Request.Builder()
.url("https://{host}/api/v1/guest-wishlists/claim")
.post(null)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.addHeader("X-Shopify-SessionId", "<api-key>")
.build()
val response = client.newCall(request).execute(){
"data": {
"migrated": true
},
"message": "Your saved wishlists are now in your account",
"messageKey": "success_guest_wishlists_claimed"
}{
"title": "Unauthenticated",
"status": 401,
"code": "UNAUTHENTICATED",
"message": "Invalid API Key",
"messageKey": null
}{
"title": "Guest disabled",
"status": 403,
"code": "GUEST_DISABLED",
"message": "Please log in to save items to your wishlist.",
"messageKey": "error_guest_login_required"
}{
"title": "Version retired",
"status": 410,
"code": "VERSION_RETIRED",
"message": "Please update the app to continue.",
"messageKey": "error_app_update_required"
}{
"title": "Rate limited",
"status": 429,
"code": "RATE_LIMITED",
"message": "Too many requests. Please try again in a minute.",
"messageKey": "error_too_many_requests"
}{
"title": "Internal error",
"status": 500,
"code": "INTERNAL_ERROR",
"message": "Something went wrong. Please try again.",
"messageKey": "error_something_went_wrong"
}Authorizations
Store API key from Wishlist settings > API Settings.
The store's myshopify domain, e.g. your-store.myshopify.com.
Numeric Shopify customer id of a logged-in shopper. Verified against the store on every call.
Guest session id generated and persisted by the client.
Response
Result