Save a shared list to mine
curl --request POST \
--url https://{host}/api/v1/shared-lists/{shareRef}/save \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <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>'
}
};
fetch('https://{host}/api/v1/shared-lists/{shareRef}/save', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/shared-lists/{shareRef}/save"
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)import Foundation
let url = URL(string: "https://{host}/api/v1/shared-lists/{shareRef}/save")!
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>"
]
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/shared-lists/{shareRef}/save")
.post(null)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.build()
val response = client.newCall(request).execute(){
"data": {
"id": 63,
"name": "My Wishlist"
},
"meta": {
"addedCount": 2
},
"message": "2 new products added to \"My Wishlist\"",
"messageKey": "error_shared_wishlist_synced",
"messageParams": {
"count": "2",
"wishlistName": "My Wishlist"
}
}{
"data": {
"id": 63,
"name": "My Wishlist",
"itemCount": 4
},
"meta": {
"itemsCopied": 4
},
"message": "Shared wishlist saved as \"My Wishlist\"",
"messageKey": "error_shared_wishlist_saved",
"messageParams": {
"wishlistName": "My Wishlist"
}
}{
"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": "Wishlist not found",
"status": 404,
"code": "WISHLIST_NOT_FOUND",
"message": "Wishlist not found",
"messageKey": "error_wishlist_not_found"
}{
"title": "Wishlist name taken",
"status": 409,
"code": "WISHLIST_NAME_TAKEN",
"message": "A wishlist with this name already exists",
"messageKey": "error_wishlist_name_already_exists"
}{
"title": "Version retired",
"status": 410,
"code": "VERSION_RETIRED",
"message": "Please update the app to continue.",
"messageKey": "error_app_update_required"
}{
"title": "Validation failed",
"status": 422,
"code": "VALIDATION_FAILED",
"message": "name is required.",
"messageKey": null,
"errors": [
{
"field": "name",
"message": "name is 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"
}{
"title": "Share verify failed",
"status": 503,
"code": "SHARE_VERIFY_FAILED",
"message": "We couldn't confirm your account just now. Please try again.",
"messageKey": "error_share_verify_failed"
}Shared lists
Save a shared list to mine
POST
/
shared-lists
/
{shareRef}
/
save
Save a shared list to mine
curl --request POST \
--url https://{host}/api/v1/shared-lists/{shareRef}/save \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <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>'
}
};
fetch('https://{host}/api/v1/shared-lists/{shareRef}/save', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/shared-lists/{shareRef}/save"
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)import Foundation
let url = URL(string: "https://{host}/api/v1/shared-lists/{shareRef}/save")!
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>"
]
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/shared-lists/{shareRef}/save")
.post(null)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.build()
val response = client.newCall(request).execute(){
"data": {
"id": 63,
"name": "My Wishlist"
},
"meta": {
"addedCount": 2
},
"message": "2 new products added to \"My Wishlist\"",
"messageKey": "error_shared_wishlist_synced",
"messageParams": {
"count": "2",
"wishlistName": "My Wishlist"
}
}{
"data": {
"id": 63,
"name": "My Wishlist",
"itemCount": 4
},
"meta": {
"itemsCopied": 4
},
"message": "Shared wishlist saved as \"My Wishlist\"",
"messageKey": "error_shared_wishlist_saved",
"messageParams": {
"wishlistName": "My Wishlist"
}
}{
"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": "Wishlist not found",
"status": 404,
"code": "WISHLIST_NOT_FOUND",
"message": "Wishlist not found",
"messageKey": "error_wishlist_not_found"
}{
"title": "Wishlist name taken",
"status": 409,
"code": "WISHLIST_NAME_TAKEN",
"message": "A wishlist with this name already exists",
"messageKey": "error_wishlist_name_already_exists"
}{
"title": "Version retired",
"status": 410,
"code": "VERSION_RETIRED",
"message": "Please update the app to continue.",
"messageKey": "error_app_update_required"
}{
"title": "Validation failed",
"status": 422,
"code": "VALIDATION_FAILED",
"message": "name is required.",
"messageKey": null,
"errors": [
{
"field": "name",
"message": "name is 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"
}{
"title": "Share verify failed",
"status": 503,
"code": "SHARE_VERIFY_FAILED",
"message": "We couldn't confirm your account just now. Please try again.",
"messageKey": "error_share_verify_failed"
}Authorizations
ApiKey & Shop & CustomerIdApiKey & Shop & SessionId
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.
Path Parameters
A numeric share id, an sh_ public share id, or the shareToken value from a share link URL.
Response
Saved before; new products copied in