Create a share link (Copy link)
curl --request POST \
--url https://{host}/api/v1/wishlists/{wishlistId}/share-links \
--header 'Content-Type: application/json' \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <api-key>' \
--header 'X-Shopify-Shop: <api-key>' \
--data '
{
"variantIds": [
"44986123976757"
]
}
'const options = {
method: 'POST',
headers: {
'X-Shopify-ApiKey': '<api-key>',
'X-Shopify-Shop': '<api-key>',
'X-Shopify-CustomerId': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({variantIds: ['44986123976757']})
};
fetch('https://{host}/api/v1/wishlists/{wishlistId}/share-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/wishlists/{wishlistId}/share-links"
payload = { "variantIds": ["44986123976757"] }
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)import Foundation
let parameters = ["variantIds": ["44986123976757"]] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://{host}/api/v1/wishlists/{wishlistId}/share-links")!
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>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"variantIds\": [\n \"44986123976757\"\n ]\n}")
val request = Request.Builder()
.url("https://{host}/api/v1/wishlists/{wishlistId}/share-links")
.post(body)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"data": {
"shareId": "sh_Lp20xA",
"url": "https://your-store.myshopify.com/pages/cb-wishlist?shareToken=Qm9yZ",
"itemCount": 1
},
"meta": {
"created": true
},
"message": "Link copied",
"messageKey": "success_share_link_copied"
}{
"title": "Malformed request",
"status": 400,
"code": "MALFORMED_REQUEST",
"message": "wishlistId must be a number.",
"messageKey": null
}{
"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": "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"
}Sharing
Create a share link (Copy link)
POST
/
wishlists
/
{wishlistId}
/
share-links
Create a share link (Copy link)
curl --request POST \
--url https://{host}/api/v1/wishlists/{wishlistId}/share-links \
--header 'Content-Type: application/json' \
--header 'X-Shopify-ApiKey: <api-key>' \
--header 'X-Shopify-CustomerId: <api-key>' \
--header 'X-Shopify-Shop: <api-key>' \
--data '
{
"variantIds": [
"44986123976757"
]
}
'const options = {
method: 'POST',
headers: {
'X-Shopify-ApiKey': '<api-key>',
'X-Shopify-Shop': '<api-key>',
'X-Shopify-CustomerId': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({variantIds: ['44986123976757']})
};
fetch('https://{host}/api/v1/wishlists/{wishlistId}/share-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/wishlists/{wishlistId}/share-links"
payload = { "variantIds": ["44986123976757"] }
headers = {
"X-Shopify-ApiKey": "<api-key>",
"X-Shopify-Shop": "<api-key>",
"X-Shopify-CustomerId": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)import Foundation
let parameters = ["variantIds": ["44986123976757"]] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://{host}/api/v1/wishlists/{wishlistId}/share-links")!
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>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"variantIds\": [\n \"44986123976757\"\n ]\n}")
val request = Request.Builder()
.url("https://{host}/api/v1/wishlists/{wishlistId}/share-links")
.post(body)
.addHeader("X-Shopify-ApiKey", "<api-key>")
.addHeader("X-Shopify-Shop", "<api-key>")
.addHeader("X-Shopify-CustomerId", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"data": {
"shareId": "sh_Lp20xA",
"url": "https://your-store.myshopify.com/pages/cb-wishlist?shareToken=Qm9yZ",
"itemCount": 1
},
"meta": {
"created": true
},
"message": "Link copied",
"messageKey": "success_share_link_copied"
}{
"title": "Malformed request",
"status": 400,
"code": "MALFORMED_REQUEST",
"message": "wishlistId must be a number.",
"messageKey": null
}{
"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": "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"
}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
Numeric wishlist id.
Pattern:
^\d+$Response
Same unused link returned again (meta.created false)