Testing Integration#

Click below to jump to the topics:

• Prerequisites for Testing
• How do I perform the E2E test cases?

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

1. Choose a Test Vendor#

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

2. 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?#

It is important to go through the end-to-end testing process. To ensure a smooth integration, you need to test various scenarios by following these steps.

1. Single product update using PUT /catalog endpoint
   Modify the request body with sku, price, active, and max_sales_quantity fields

   1. Check the API response as 200
   2. Check your catalog and frontend for changes to the sku

2. Bulk product updates using PUT /catalog endpoint (recommended to configure webhook to visibility on job logs)

   1. Add multiple SKUs with the product attributes sku, price, active, and max_sales_quantity
   2. Check for API response 202
   3. Async job details are sent to configured webhook, containing downloadURL
   4. Use GET on the downloadURL with the bearer token
   5. Download the logs at sku level

3. Create new products at store or chain level using POST /catalog endpoint

   1. Prepare the request body with product details, include list of vendors or use wild character( * ) to create products on all vendors at chain level
   2. Check for API response 202
   3. Save the job_id from the response

4. Check the product creation status using GET /job_id endpoint

   1. On successful request check for 200 response with one of the following job statuses
      1. QUEUED the job has not yet been processed
      2. IN_PROGRESS the products/items are being added to your outlet
      3. COMPLETED the job is finished
      4. FAILED the job processing failed

5. POST /export endpoint

   1. Request with vendor-id
   2. Check for API response 202
   3. Async job details are sent to configured webhook, containing downloadURL
   4. Use GET on the downloadURL with the bearer token
   5. Download the assortment data includes, SKU, price, active, max_sales_quantity fields

6. GET /categories
   Retrieves list of available vendor categories

7. GET /catalog
   Contains catalog information in paginated format SKU, translations, product descriptions, image URLs, etc