Wishlists – Get
Method & Endpoint
GET
/wishlists
Description
Returns a list of all open wishlists currently active on your store.
Query Parameters
page (number, optional)
The page of results to retrieve.-
Default:
1
rows (number, optional)
Number of results to return.-
Default:
50 -
Maximum:
250
email (string, optional)
Filters wishlists by matching the owner's Shopify email address.
customer_id (number, optional)
Filters wishlists by matching Shopify customer ID.
Request Body
This endpoint does not accept a request body.
Response
Returns an array of open wishlists, including owner and product data.
Example response
{
"wishlists": [
{
"id": 51453,
"created": "2014-06-07T14:23:56",
"extra": null,
"owner": { ... },
"products": [ ... ]
}
]
}
Response Fields
-
id
(number)— Wishlist ID (Gift Reggie). -
created
(string)— ISO 8601 timestamp of creation. -
extra
(string|null)— Internal notes (Gift Reggie).
owner (object) — Customer data from
Shopify:
-
email
(string)— Shopify customer email. -
id
(number)— Internal user ID (Gift Reggie). -
first_name
(string)— Shopify customer first name. -
last_name
(string)— Shopify customer last name.
products (array) — Products on the
wishlist:
-
id
(number)— Wishlist product ID (Gift Reggie). -
product_id
(number)— Shopify product ID. -
variant_id
(number)— Shopify variant ID. -
sku
(string)— Shopify SKU. -
image
(string)— Shopify product image URL. -
inventory_quantity
(number)— Shopify inventory count. -
tags
(string)— Shopify product tags (comma-separated).
Wishlists – Post
Method & Endpoint
POST
/wishlists
Description
Creates a new wishlist on the store associated to a specified user email. Adding products to a wishlist is done in a separate call.
Request Body
Example request
{ "wishlist": { "owner": { "email": "abc@abc.com" } } }
email — Shopify customer email. Required if
customer_id is not provided.
customer_id — Shopify customer ID. Preferred if both present.
Response
Returns the newly created wishlist.
Example response
{
"wishlist": {
"created": "2024-08-28T19:27:50",
"products": [],
"id": 1208222,
"extra": null,
"owner": {
"last_name": "abc",
"first_name": "abc",
"email": "abc@abc.com",
"customer_id": 7760485908718,
"id": "4298738"
}
}
}
Response Fields
-
id
(number)— Wishlist ID (Gift Reggie). -
created
(string)— ISO 8601 timestamp of creation. -
extra
(string|null)— Internal notes (Gift Reggie).
owner (object) — Customer data from
Shopify:
-
email
(string)— Shopify customer email. -
first_name
(string)— Shopify customer first name. -
last_name
(string)— Shopify customer last name. -
customer_id
(number)— Shopify customer ID. -
id
(string)— Internal user ID (Gift Reggie).
Wishlists – Put
Method & Endpoint
PUT
/wishlists/{wishlist_id}
Description
Replaces the wishlist’s product list with the provided Shopify variant IDs. Existing products are fully overwritten.
Request Body
Example request
{ "wishlist": { "variant_ids": [54396789322,76575615447], "extra": "Gift note" } }
variant_ids — Array of Shopify variant IDs (required).
extra — Internal notes (Gift Reggie) (optional).
Response
Returns the updated wishlist. Same format as Wishlists – Get.
Wishlists – Count
Method & Endpoint
GET
/wishlists/count
Description
Returns the total number of wishlists on your store.
Response
Example response
{ "count": 128 }
Response Fields
-
count
(number)— Total number of wishlists (Gift Reggie).
Registries – Post
Method & Endpoint
POST
/registries
Description
Creates a new registry on the store. Products must be added in a separate call.
Request Body
Example request
{
"registry": [
{
"name": "Test User's Wedding",
"event_date": "2024-10-19",
"contact_email": "testuser@gmail.com",
"registrant_first": "John",
"registrant_last": "Doe"
}
]
}
Required fields: name,
event_date
Optional fields: coregistrant_first,
coregistrant_last, contact_email,
in_store_pickup, before_address,
after_address, contact_province,
contact_daytime, admin_description,
description, closed, extra,
event_type, registrant_first,
registrant_last, contact_address,
contact_city, contact_country,
contact_postal
Registries – Put
Method & Endpoint
PUT
/registries/{registry_id}
Description
Updates data on an existing registry. You only need to include the fields you wish to update. You can also update registry managers here. If you do so, update all managers. Product updates are made via a different endpoint.
Modifiable fields: name,
event_date, event_type,
about_type, admin_description,
closed, registrant_title,
registrant_first, registrant_last,
coregistrant_title, coregistrant_first,
coregistrant_last, contact_address,
contact_city, contact_province,
contact_country, contact_postal,
contact_daytime, contact_evening,
contact_email, in_store_pickup,
extra, description
Registries – Count
Method & Endpoint
GET
/registries/count
Description
Returns the total number of registries on the store, including open and closed ones.
Registries – Get Registry
Method & Endpoint
GET
/registries/{registry_id}
Description
Retrieves information about a specific registry. Does not include product data.
Registries – Get Products
Method & Endpoint
GET
/registries/{registry_id}/products
Description
Retrieves product data on a specific registry.
Query Parameters
page (number, optional)
Page of results. Default: 1.
rows (number, optional)
Number of results. Default: 50, max 250.
Registries – Get Product Count
Method & Endpoint
GET
/registries/{registry_id}/products/count
Description
Returns the number of products associated with a registry.
Registries – Put Products
Method & Endpoint
PUT
/registries/{registry_id}/products
Description
Add or modify products on a registry. If you include products in your call not already on a registry those will be added. Unlike the wishlist endpoint, this call does not override all existing product data. You only need to include data about products you want to change. If products exist on a registry, but not in your request, then they will be unchanged
Example request
{
"products": [
{
"id": "7764257865904",
"variants": [
{
"id": "44114246238384",
"wants": 5,
"purchased": 10
},
{
"id": "441142462385711",
"wants": 0
}
]
}
]
}
wants — Quantity the registry owner is requesting for a variant.
purchased — Already purchased quantity (optional).
Registries – Get Orders
Method & Endpoint
GET
/registries/{registry_id}/orders
Description
Returns orders associated with a specific registry.
Registries – Put Orders
Method & Endpoint
PUT
/registries/{registry_id}/orders
Description
Associates an existing Shopify order with a registry by order ID or order name.
Example input
{ "order": { "order_id": 12324324324 } }
{ "order": { "name": "#1002" } }