Skip to main content

Notify Me Public API

Access Notify Me operational data for syncing and reporting.

The Notify Me Public API lets you securely access your operational data so you can sync it with your own systems, such as warehouses, planning tools, or reporting dashboards.

This API is currently read-only and cannot make changes to your store or customer data.

What the Public API is for

The Public API is designed for operational visibility and data synchronization. It’s most useful if you:

  • Use a 3PL or warehouse system and need real-time pre-order data

  • Want to sync restock waitlists into internal tools or BI dashboards

  • Need automated access to Notify Me data instead of manual exports

What data you can access

With the Public API, you can access:

  • Pre-order data, including order details and fulfillment status

  • Restock subscription and waitlist data for out-of-stock products

The API is optimized for high-volume data that changes frequently and is suitable for regular syncing.

Creating an API key

To get started, you’ll need to generate an API key. You can create more than one key, so you can use a separate key for each system you connect.

Steps:

  1. Open Notify Me in your Shopify admin

  2. Go to Settings

  3. Select API keys

  4. Click Generate API key

  5. Give the key a Name so you know where it’s used. The name helps you identify this key later, for example “Warehouse integration”.

  6. Optionally set an Expiry date (optional). Leave it as No expiry if the key should never expire, or pick a date after which the key stops working.

  7. Click Generate API key
    ​

Once created, the full API key will be shown only once. Make sure you copy and store it securely before closing the window.

Managing your API keys

Your keys are listed on the API keys page. You can keep several keys active at the same time, each with its own name and expiry.

The list shows, for each key:

  • Name — the label you gave the key when you created it

  • Key — the key’s prefix, shown masked (for example qoTILoKv****)

  • Created at — the date the key was created

  • Expires — the key’s expiry date, or Never if you didn’t set one

Each key has its own Rotate key and Revoke key buttons on its row, so you can manage keys independently.

If you have a lot of keys, keep scrolling the list to load more.

Rotating an API key

If you believe a key may be compromised or you want to refresh it for security reasons, you can rotate it. Find the key in the list and click Rotate key on its row.

When you rotate a key:

  • The current key is invalidated

  • A new key is generated immediately, with the same name

  • Any systems using the old key must be updated

The new key is shown only once, just like when you first create a key — copy and store it before closing the window. Rotating one key does not affect your other keys.

Revoking an API key

If a key is no longer needed or should no longer have access, you can revoke it. Find the key in the list and click Revoke key on its row.

When you revoke a key:

  • Access is disabled immediately

  • The key cannot be used again

  • Any connected systems will stop working

Revoking one key does not affect your other keys.

Viewing API documentation

Full API documentation is available from the API keys page. The documentation includes:

  • Authentication details

  • Available endpoints

  • Request and response examples

  • Error handling and rate limits

Use this documentation when building or maintaining your integration.

Screen Recording Dec 15 2025.mov [video-to-gif output image]
Related Articles
Did this answer your question?