This article walks through creating an API user in ideal.shop, connecting those credentials to ProfitMetrics, and adding your ProfitMetrics Public ID to your store's integration settings.
What You Need
| REQUIREMENT | DETAILS |
|---|---|
| Ideal Shop admin access | Ability to create API users under Settings > Integrations > API |
| ProfitMetrics account | Access to the Integrations section and Websites page in ProfitMetrics |
Step 1 — Create an API User in Ideal Shop
- In your ideal.shop administration, go to Settings > Integrations > API.
- Click Add API user and fill out the form. The Title and User name fields can be anything you'd like — for example,
ProfitMetrics. - Make sure the Active toggle is enabled, then click Save.
- Click the Edit button on the API user you just created. Copy the User name and API key — you'll need these in the next step.
Tip: Keep the ideal.shop API page open in a separate tab so you can copy the credentials directly into ProfitMetrics.
Step 2 — Add the API Credentials to ProfitMetrics
- In ProfitMetrics, go to Integrations > E-Commerce Platforms > Ideal Shop.
- Paste the credentials from Step 1 into the corresponding fields:
| FIELD | VALUE |
|---|---|
| API username | The user name from your ideal.shop API user |
| API key | The API key from your ideal.shop API user |
| Order import start date | The earliest date from which ProfitMetrics should begin importing orders |
- Save the integration settings.
Step 3 — Add Your ProfitMetrics Public ID to Ideal Shop
- In ProfitMetrics, go to Websites and copy the Public ID for the website you want to connect.
- In your ideal.shop administration, go to Settings > Integrations > ProfitMetrics.
- Paste the Public ID into the Public ID field and save.
This enables ideal.shop to send tracking data directly to ProfitMetrics from your storefront.
Verifying the Connection
After completing all three steps, place a test order in your store and check the Orders section in ProfitMetrics. The order should appear within a few minutes. Compare the order total and line items against your ideal.shop admin to confirm the data is accurate.
Troubleshooting
| ISSUE | WHAT TO CHECK |
|---|---|
| Orders not appearing | Confirm the API user's Active toggle is enabled in ideal.shop. Double-check the API username and API key for typos or trailing spaces. |
| Orders only from a certain date | Check the Order import start date — ProfitMetrics will not import orders placed before this date. |
| Tracking not firing on storefront | Verify the Public ID is correct in Settings > Integrations > ProfitMetrics inside ideal.shop. |
If the issue persists, contact ProfitMetrics support with your website URL and a screenshot of your integration settings.