Lists for the picker, with this product's state

curl --request GET \
  --url https://{host}/api/v1/products/{productId}/wishlists \
  --header 'X-Shopify-ApiKey: <api-key>' \
  --header 'X-Shopify-CustomerId: <api-key>' \
  --header 'X-Shopify-Shop: <api-key>'

const options = {
  method: 'GET',
  headers: {
    'X-Shopify-ApiKey': '<api-key>',
    'X-Shopify-Shop': '<api-key>',
    'X-Shopify-CustomerId': '<api-key>'
  }
};

fetch('https://{host}/api/v1/products/{productId}/wishlists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/api/v1/products/{productId}/wishlists"

headers = {
    "X-Shopify-ApiKey": "<api-key>",
    "X-Shopify-Shop": "<api-key>",
    "X-Shopify-CustomerId": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

import Foundation

let url = URL(string: "https://{host}/api/v1/products/{productId}/wishlists")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
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/products/{productId}/wishlists")
  .get()
  .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": 52,
      "name": "Birthday picks",
      "isPublic": true,
      "containsProduct": true
    },
    {
      "id": 61,
      "name": "Diwali gifts",
      "isPublic": false,
      "containsProduct": false
    }
  ],
  "meta": {
    "wishlistMode": "multiple",
    "singleWishlistId": null
  }
}

{
  "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"
}

GET

products

{productId}

wishlists

Lists for the picker, with this product's state

curl --request GET \
  --url https://{host}/api/v1/products/{productId}/wishlists \
  --header 'X-Shopify-ApiKey: <api-key>' \
  --header 'X-Shopify-CustomerId: <api-key>' \
  --header 'X-Shopify-Shop: <api-key>'

const options = {
  method: 'GET',
  headers: {
    'X-Shopify-ApiKey': '<api-key>',
    'X-Shopify-Shop': '<api-key>',
    'X-Shopify-CustomerId': '<api-key>'
  }
};

fetch('https://{host}/api/v1/products/{productId}/wishlists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/api/v1/products/{productId}/wishlists"

headers = {
    "X-Shopify-ApiKey": "<api-key>",
    "X-Shopify-Shop": "<api-key>",
    "X-Shopify-CustomerId": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

import Foundation

let url = URL(string: "https://{host}/api/v1/products/{productId}/wishlists")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
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/products/{productId}/wishlists")
  .get()
  .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": 52,
      "name": "Birthday picks",
      "isPublic": true,
      "containsProduct": true
    },
    {
      "id": 61,
      "name": "Diwali gifts",
      "isPublic": false,
      "containsProduct": false
    }
  ],
  "meta": {
    "wishlistMode": "multiple",
    "singleWishlistId": null
  }
}

{
  "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

X-Shopify-ApiKey

string

header

required

Store API key from Wishlist settings > API Settings.

X-Shopify-Shop

string

header

required

The store's myshopify domain, e.g. your-store.myshopify.com.

X-Shopify-CustomerId

string

header

required

Numeric Shopify customer id of a logged-in shopper. Verified against the store on every call.

Path Parameters

productId

string

required

Numeric Shopify product id.

Pattern: ^\d+$

Query Parameters

variantId

string

Omit to match any variant of the product.

Pattern: ^\d+$

Response

Every list of the shopper

data

object[]

Show child attributes

Getting started

Settings

Wishlists

Items

Product

Shared lists

Sharing

Account

Lists for the picker, with this product's state

Authorizations

Path Parameters

Query Parameters

Response