Sandbox Testing#

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

• Go to the Partner Portal and create the sandbox environment, you will find this option in Shops Integrations Plugin, near your chain name:

• After your sandbox is created, proceed to setting it up by clicking "Set up sandbox" on the pop-up window.

Step 1: Set up Sandbox

• Generate sandbox credentials: Client ID and Client Secret

Step 2: Retrieve data for your sandbox environment

• Download sandbox vendor identifiers (the unique identifiers of stores within the platform), these are system generated and might be different from the production ones you are using

• Create the access token in order to send further requests. Copy the given cURL, use your credentials created earlier and send the request to create the token:

• Get the sandbox assortment data, which might be different from your products in production. Send the GET request in your preferred API testing tool (e.g. Postman) and receive the list of SKUs (skip this step if it is not applicable for your integration)

  Step 3: Enter Webhook Settings

• Add your Assortment Webhook to the given field. And use preferred API testing tool to update the Catalog information(price/stock). After that your webhook will receive the whole snapshot of the statuses of all products you have updated. (skip this step if it is not applicable for your integration)

• Add your Order Webhook URL and click "Continue":

Step 4: Place a test Order

• If you want to test the flow for fulfilling an order for Partner Picking Integration:

  1. Select the order status as RECEIVED and select the preferred delivery type: LOGISCTICS_DELIEVRY(platform delivery) or VENDOR_DELIVERY (your own delivery)

  2. You will receive RECEIVED event to your webhook with all item level information.

  3. Send PUT request to fulfil the order with either READY_FOR_PICKUP event (if you chose LOGISCTICS_DELIEVRY) or DISPATCHED (if you chose VENDOR_DELIVERY). Please check more details on the endpoints in API specification documentation.

4. Now you will receive READY_FOR_PICKUP event to your webhook.

If you want to test the flow to cancel an order for Partner Picking Integration:

1. Select the order status as RECEIVED, select the preferred delivery type: LOGISCTICS_DELIEVRY(platform delivery) or VENDOR_DELIVERY (your own delivery).

2. You will receive RECEIVED event to your webhook with all item level information.

3. Send PUT request to cancel the order with CANCELLED event. Please add the reason for the cancellation, for example CLOSED, ITEM_UNAVAILIBLE or TOO_BUSY. You can check more details on the endpoints in API specification documentation.

4. Now you will receive CANCELLED event to your webhook.

If you want to test the webhook for Pelican Picking Integration:

1. Select the order status as READY_FOR_PICKUP and delivery type LOGISCTICS_DELIVERY

2. Add an SKU to the order and select the item status as IN_CART

3. Click on Trigger order

4. You will now receive READY_FOR_PICKUP event to your webhook.