Testing Integration#

Click below to jump to the topics:

• Prerequisites for Testing
• How do I perform the E2E testing?

Prerequisites for Testing#

In order to test your integration, you’ll need to do the following:#

Choose a Test Vendor#

• Option 1: Use an existing test vendor from your chain
• Option 2: Create and onboard a new test store for testing

Validate Your Integration#

You can leverage our end-to-end (E2E) test cases to validate that integration meeting your requirements

How do I perform E2E testing?#

In order to send requests , please create a Bearer Token in Partner Portal. Please refer to the Token Management & Access Section.

As you send the request to update the product - an asynchronous job will be created in the background, meaning that the job is later sent to the configured webhook.

Creating a Promotion#

1. Prepare the Request:
   1. Create the API request to create a promotion.
   2. Ensure the request contains valid SKUs and promotion details.
      Note!
2. Send the Request: When the request is submitted, the status of the promotion will be queued, meaning it is in the process of being created.
3. Check Promotion Status: Use the GET endpoint to query the status of the promotion and confirm its completion.
4. Review the Promotion: Validate the promotion in the Vendor Portal or the Platform App to ensure it was successfully created.

Best Practices:#

1. To minimize operational impact, create promotions for one or two products with a small discount (e.g. a few cents).
2. Ensure the discounted price is always lower than the original price; otherwise, the promotion will not be created.
3. Consider running promotions outside of working hours to avoid potential disruptions.

Modifying a Promotion#

1. Prepare the Modification Request:
   1. Use the same API request as for the promotions creation.
   2. To remove a SKU, set "active": false at the SKU level.

2. Submit the Request: Send the request and ensure the job is processed.
   1. Check the Update Status: Use the GET endpoint to confirm the job was completed.
   2. Validate in the Vendor Portal: Verify that the SKU was successfully removed from the promotion.

Deactivating a Promotion#

1. Prepare the Deactivation Request: Send the same request with "active": false at the campaign level.
2. Submit the Request: The promotion will be deactivated upon successful processing.
3. Confirm Deactivation: Use the GET endpoint to ensure the job was completed.
4. Verify in the Vendor Portal: Confirm that the promotion is no longer active.