Welcome to Gift Reggie's API documentation. We're always looking for feedback, if there's any feature you'd like implemented send us an email, support@moddapps.com or submit a ticket from our help center.
Wishlists
Wishlists can be accessed via https://gift-reggie.eshopadmin.com/api/store_id/wishlists
GET https://gift-reggie.eshopadmin.com/api/store_id/wishlists
Retrieves a listing of all wishlists on your store.
-
rows (optional)
Rows allow you to specify how many items you'd like to receive in this API call.
Mimimum Value: 0 Default Value: 50 Maximum Value: 250 -
page (optional)
Specifies which page of results you'd like to get.
Default Value: 1
- Example Results
{ "wishlists": [ { "id": 51453, "created": "2014-06-07T14:23:56", "owner" => { "email": "example@example.com", "id": 342342, "first_name": "Navi", "last_name": "Kokiri" } "products": [ { "id": 431234 "product_id": 15634563465, "variant_id": 54396789322, "sku": "HTS-2300", "image": "http://cdn.shopify.com/asdsasdf/ofaogfljfdg/img.jpg", "inventory_quantity": 20, "tags": "prelude, minuet, bolero, serenade, requiem, nocturne" }, { "id": 12231 "product_id": 11342342342, "variant_id": 76575615447, "sku": "HTS-434351", "image": "http://cdn.shopify.com/avxzcvxcvzxcvsdsasdf/fasdv/img.png", "inventory_quantity": 12, "tags": "sonata, lullaby, bossa nova, elegy, oath" } ] } ] }
POST https://gift-reggie.eshopadmin.com/api/store_id/wishlists
Creates a new wishlist on the store.
- Example Results
{
"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"
}
}
}PUT https://gift-reggie.eshopadmin.com/api/store_id/wishlists/<wishlist_id>
Update Products in a wishlist. This request will add all the products in the variant_ids array and remove any products already in the wishlist but not in this array.
- Example Results
{ "wishlist": { "id": 1208222,
"products": [{ "sku": "", "title": "T Shirt - Brown / S", "variant_id": 45655281664238, ...}]
} }GET https://gift-reggie.eshopadmin.com/api/store_id/wishlists/count
Retrieves the count of wishlists in your store.
Registries:
GET https://gift-reggie.eshopadmin.com/api/store_id/registries
Retrieves a listing of all registries on your store.
-
rows (optional)
Rows allow you to specify how many items you'd like to receive in this API call.
Mimimum Value: 0 Default Value: 50 Maximum Value: 250 -
page (optional)
Specifies which page of results you'd like to get.
Default Value: 1 -
customer_id (optional)
If specified, will only return registries with this customer id included as a manager of that registryDefault Value: undefined -
closed (optional)
By default, closed registries are not returned. You may specify to include them in the resultsDefault Value: 0 Optional Value: 1 -
no_password (optional)
Specify to include only registries without passwords in the resultsDefault Value: 0 Optional Value: 1
- Example Results
{ "registries": [ { "event_date": "2025-12-12T00:00:00", "registrant": "john doe", "before_address": null, "about_type": "N/A", "created": "2020-06-30T15:20:25", "contact_address": "123 test street", "has_password": 0, "registrant_last": "doe", "coregistrant_title": null, "coregistrant": null, "id": 100000, "name": "John Doe and Jane Doe's Wedding", "registrant_title": "", "image": "https://example_url/static/registry_images/12345.jpg", "contact_postal": "90210", "registrant_first": "john", "share_count": 0, "event_type": "N/A", "extra": "", "product_count": 27, "closed": null, "contact_daytime": "5555555555", "contact_country": "Canada", "after_address": null, "coregistrant_last": null, "contact_city": "quebec", "managers": [], "coregistrant_first": null, "contact_email": "test@email.com", "admin_description": "", "contact_evening": "", "expired": null, "contact_province": "quebec", "description": "Help Jane and John with their wedding", "in_store_pickup": 0 }, { "id": 100001, "coregistrant": "test name", "coregistrant_title": null, "registrant_first": "example", "contact_postal": "h1n 1o9", "image": null, "registrant_title": "owner", "name": "Wedding Registry Example", "about_type": "N/A", "created": "2021-04-01T18:52:53", "before_address": null, "registrant": "example name", "event_date": "2025-12-12T00:00:00", "registrant_last": "Support", "has_password": 0, "contact_address": "123 test street", "managers": [ { "email": "test@email.com", "id": 1500000, "first_name": "example", "last_name": "name", "customer_id": 4567894567890 } ], "in_store_pickup": 1, "description": "", "contact_province": "quebec", "contact_evening": "", "expired": null, "admin_description": "", "contact_email": "test@email.com", "coregistrant_first": "test", "product_count": 7, "extra": "", "event_type": "Wedding", "share_count": 0, "contact_city": "quebec", "coregistrant_last": "name", "after_address": null, "contact_daytime": "5555555555", "contact_country": "Canada", "closed": null } ] }
POST https://gift-reggie.eshopadmin.com/api/store_id/registries
Creates a new registry on the store.
PUT https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>
Updates a registry with new properties. 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.
GET https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>
Retrieve information about a single registries.
GET https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>/products/count
Retrieve the count of products on a registry.
GET https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>/products
Retrieve orders associated to a registry.
PUT https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>/products
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
Define a list of products, each with a list of variants, that you want to modify on the registry
wants - the amount of this variant that the registry owner requires.
purchased - the amount of items already purchased on the registry you wish to update. optional.
- Example Input
{ "products": [ { "id": "7764257865904", "variants": [ { "id": "44114246238384", "wants": 5, "purchased": 10 } ] } ] }
- Example Results
{ "products": [ { "properties": {}, "variant_id": 44114246238384, "price": "1100.00", "id": 6571040, "published_at": "2024-12-13T13:15:36", "position": 4, "tags": "egnition-sample-data, painting, post-impressionism", "metafields": {}, "purchased": 0, "purchased_modifier": 10, "handle": "self-portrait-without-beard-vincent-van-gogh", "product_id": 7764257865904, "sku": "PAINT09", "inventory_quantity": 18, "image": "example_url", "needs": -10, "wants": 5, "title": "SELF-PORTRAIT WITHOUT BEARD | VINCENT VAN GOGH" } ]}
GET https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>/orders
Retrieve orders associated to a registry.
- Example Results
{ "orders": [{ id: 12312432432, "product_id": 123123123, "variant_id": 34324324324, "order_id": 12324324, "quantity": 2, "created": "2018-08-10T00:00:00", "updated": "2018-08-10T00:00:00", "cancelled": null, "closed": null, "price": 20.00, "title": "Sample Item", "name": "#1001", "properties": {}, "manual": true }] }
PUT https://gift-reggie.eshopadmin.com/api/store_id/registries/<registry_id>/orders
Associate an order to a registry.
GET https://gift-reggie.eshopadmin.com/api/store_id/registries/count
Retrieves the count of registries in your store.