Shopify Public App

1. Introduction: Needing a Public Shopify app to integrate with our existing platform. This app will facilitate the configuration of three essential parameters: Merchant Key, Campaign Group ID, and Event ID. These parameters will be utilized in conjunction with Shopify's checkout_complete customer event to pass data between Shopify stores and our API.

2. App Overview: The Shopify app will provide a simple, intuitive interface to be able to enter the Merchant Key, Campaign Group ID, and Event ID within the app's settings.

3. Functional Requirements:

Input Fields:

Merchant Key: A unique identifier provided by us to authenticate the Shopify store.

Campaign Group ID: Identifies the group of campaigns within our business platform.

Event ID: Specifies the event id within our business platform that corresponds to the Shopify checkout_complete event.

Integration with Shopify's checkout_complete Event:

Upon the completion of a checkout process on the Shopify store, the app will trigger the Shopify checkout_complete event. The app will utilize the provided Merchant Key, Campaign Group ID, and Event ID to transmit relevant sale data to us.

4. Technical Implementation:

Frontend Development:

Develop a user-friendly interface to capture and validate the input fields on initial app setup.

Integration with API:

Utilize our API to transmit order details to our platform upon the occurrence of the Shopify checkout_complete event.

5. Testing:

Conduct thorough testing of the app's functionality, including event triggering, and data transmission.

Perform integration testing with our test platform to ensure seamless communication and data accuracy.

7. Documentation:

Provide comprehensive code comments and explanation of code processes.