Get one wishlist (owner only)

GET /wishlists/{wishlistId}

Get one wishlist (owner only)

cURL

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

200

{
  "data": {
    "id": 123,
    "name": "<string>",
    "isPublic": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "isOwner": true,
    "items": [
      {
        "id": 123,
        "wishlistId": 123,
        "productId": "<string>",
        "variantId": "<string>",
        "title": "<string>",
        "variantTitle": "<string>",
        "handle": "<string>",
        "image": "<string>",
        "price": "<string>",
        "currency": "<string>",
        "availableForSale": true,
        "metafields": {},
        "variants": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "sharedWith": [
      {
        "name": "<string>",
        "email": "<string>",
        "isGuest": true
      }
    ],
    "sharedBy": {
      "name": "<string>",
      "email": "<string>",
      "isGuest": true
    }
  },
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalItems": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  },
  "meta": {
    "planFeatures": {
      "wishlistSharing": true,
      "shareViaEmail": true
    },
    "tabCounts": {
      "mine": 123,
      "sharedWithMe": 123,
      "sharedByMe": 123
    },
    "moveTargets": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  }
}

Authorizations

ApiKey & Shop & CustomerIdApiKey & Shop & SessionId

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

wishlistId · string · required

Numeric wishlist id.

Pattern: ^\d+$

Query Parameters

page · integer · default: 1

Required range: x >= 1

limit · integer · default: 5

Page size. Server default is 5 when omitted.

Required range: 1 <= x <= 50

locale · string

Language for product titles (Storefront API).

country · string · default: US

Market country code for prices.

withCounts · enum<string>

true or 1 adds meta.tabCounts (page 1 only).

Available options: true, 1, false, 0

withMoveTargets · enum<string>

Adds meta.moveTargets: the shopper's other lists (id, name).

Available options: true, 1, false, 0

Response

200

application/json

The list with paged items

data · object

Show child attributes

pagination · object

Show child attributes

meta · object

Show child attributes