Create a wishlist

curl --request POST \
  --url https://{host}/api/v1/wishlists \
  --header 'Content-Type: application/json' \
  --header 'X-Shopify-ApiKey: <api-key>' \
  --header 'X-Shopify-CustomerId: <api-key>' \
  --header 'X-Shopify-Shop: <api-key>' \
  --data '
{
  "name": "Diwali gifts"
}
'

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({name: 'Diwali gifts'})
};

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

import requests

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

payload = { "name": "Diwali gifts" }
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 = ["name": "Diwali gifts"] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://{host}/api/v1/wishlists")!
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  \"name\": \"Diwali gifts\"\n}")
val request = Request.Builder()
  .url("https://{host}/api/v1/wishlists")
  .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": {
    "id": 61,
    "name": "Diwali gifts",
    "isPublic": false,
    "itemCount": 0,
    "createdAt": "2026-10-07T08:30:00.000Z",
    "items": []
  },
  "message": "Wishlist \"Diwali gifts\" created successfully",
  "messageKey": "success_wishlist_created",
  "messageParams": {
    "wishlistName": "Diwali gifts"
  }
}

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

POST

wishlists

Create a wishlist

curl --request POST \
  --url https://{host}/api/v1/wishlists \
  --header 'Content-Type: application/json' \
  --header 'X-Shopify-ApiKey: <api-key>' \
  --header 'X-Shopify-CustomerId: <api-key>' \
  --header 'X-Shopify-Shop: <api-key>' \
  --data '
{
  "name": "Diwali gifts"
}
'

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({name: 'Diwali gifts'})
};

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

import requests

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

payload = { "name": "Diwali gifts" }
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 = ["name": "Diwali gifts"] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://{host}/api/v1/wishlists")!
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  \"name\": \"Diwali gifts\"\n}")
val request = Request.Builder()
  .url("https://{host}/api/v1/wishlists")
  .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": {
    "id": 61,
    "name": "Diwali gifts",
    "isPublic": false,
    "itemCount": 0,
    "createdAt": "2026-10-07T08:30:00.000Z",
    "items": []
  },
  "message": "Wishlist \"Diwali gifts\" created successfully",
  "messageKey": "success_wishlist_created",
  "messageParams": {
    "wishlistName": "Diwali gifts"
  }
}

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

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.

Body

application/json

name

string

required

Required string length: 1 - 75

Response

Created

Getting started

Settings

Wishlists

Items

Product

Shared lists

Sharing

Account

Create a wishlist

Authorizations

Body

Response