Summary of Actions #
Action | Purpose | Detail |
---|---|---|
Create a Private App for Replenit | Enable integration between Shopify and Replenit | Create a private app in your Shopify admin to allow Replenit access to necessary data. |
Configure Data Settings | Ensure proper data synchronization | Customize synchronization settings for orders, products, and customers. |
Activate Webhooks | Receive real-time notifications for key events | Enable webhooks for orders, customers, and products in your Shopify admin panel. |
Share Configuration Details | Finalize the setup with Replenit | Share the necessary details, including active webhook settings, with your Replenit contact. |
1. Create a Private App for Replenit #
Purpose
To establish a secure connection between your Shopify store and Replenit for data synchronization.
Steps
- Log in to your Shopify admin panel.
- Navigate to Settings > Apps and Sales Channels.
- Click Develop Apps and select Create an App.
- Name the app (e.g., “Replenit”) and configure the necessary permissions:
- Orders: Read access for order history.
- Customers: Read access for customer data.
- Products: Read access for product catalog.
- Save the app and generate API credentials (API Key and Password).
- Share these credentials with your Customer Success Manager (CSM).
- Replenit will integrate with your Shopify store once the private app is configured.
2. Configure Data Settings #
Purpose
To ensure that the Replenit app collects and processes the correct data for your store.
Steps
- Navigate to the Replenit App in your Shopify admin.
- Configure the following settings as needed:
- Order Data: Enable order synchronization to track purchase history.
- Customer Data: Enable customer data synchronization for profile management.
- Product Data: Enable product synchronization to ensure accurate inventory tracking.
- Save the settings.
These settings allow Replenit to start processing and using your Shopify store data.
3. Activate Webhooks #
Purpose
To receive real-time notifications for specific events like new orders, product updates, or customer changes.
Mandatory Webhooks #
Event | URL |
---|---|
Customer Created | https://services.replen.it/shopify/webhooks/{clientId}/users/upsert?clientname={clientname} |
Customer Deleted | https://services.replen.it/shopify/webhooks/{clientId}/users/delete?clientname={clientname} |
Order Payment | https://services.replen.it/shopify/webhooks/{clientId}/transactions/create?clientname={clientname} |
Order Cancelation | https://services.replen.it/shopify/webhooks/{clientId}/transactions/cancel?clientname={clientname} |
Product Created | https://services.replen.it/shopify/webhooks/{clientId}/products/create?clientname={clientname} |
Product Deleted | https://services.replen.it/shopify/webhooks/{clientId}/products/delete?clientname={clientname} |
Product Updated | https://services.replen.it/shopify/webhooks/{clientId}/products/update?clientname={clientname} |
Steps to Create Webhooks
- Log in to your Shopify admin panel.
- Navigate to Settings > Notifications.
- Scroll down to the Webhooks section and click Create webhook.
- Select the event type (e.g., Order Payment, Customer Created).
- Set the format to JSON.
- Enter the corresponding Webhook URL from the table above.
- Click Save webhook.
- Repeat these steps for all required events.
4. Share Configuration Details #
Purpose
To finalize the setup and ensure Replenit can process your data effectively.
Steps
- Provide your Customer Success Manager (CSM) with the following details:
- Confirmation that the Replenit private app is created and configured.
- List of enabled webhooks.
- Any special data settings configured in the Replenit app.
- Client ID: You can access your Client ID in the platform under the Data Health and Management section.
- This step ensures Replenit’s middleware processes your data without interruption.
Best Practices #
- Test Webhooks: Verify that webhooks are working by triggering sample events in your Shopify store (e.g., create a test customer).
- Keep Data Clean: Ensure your Shopify store data is accurate and complete for effective synchronization.
- Monitor Syncs: Periodically check the Replenit app dashboard for sync statuses and logs.
Contact and Support #
For any questions or support during the integration process, please contact the Replenit team at
[email protected].