ShipMonk Integration

OVERVIEW 

The integration between ShipMonk and Loop is a two-way integration that creates return records (ASN or RA) within ShipMonk when a return is initiated in Loop. Once the RMA is processed on the ShipMonk side, the return is processed in Loop. ShipMonk owns and maintains this integration. 

In this article—

• How it works
• Setup 
• Troubleshooting
• Automate marking RMA as Process

How it works

The return in ShipMonk is created with Order Number used as RMA so customers can easily tell which order the Return belongs to. The return is also updated to include the label tracking information from Loop as well. 

ShipMonk receives two webhooks from Loop in order to make a return in their system: 

1. Return Created: triggered when Return is created in Loop 

• order_name (order name from Shopify) —> RMA
  • If there is more than 1 RMA for a single order, the automated suffix is added to the RMA (i.e., "_01", "_02", etc.)
• SKU —> SKU mapping
• return_reason —> Reasons are added to the RMA as Notes in the ShipMonk app

2. Label Created: triggered when a label is created for a Return 

• The tracking number is attached to the RMA

Setup 

The merchant will need to set up the webhooks in Loop and then share the webhook secret with ShipMonk for authentication.

1. In the Loop admin, head to Tools & integrations > Developers. If you do not have access to the Developers tab, please reach out to your Merchant Success Manager or support@loopreturns.com for assistance. 

2. Create two webhooks in the Loop Admin with this data:

3. For the first webhook:

Return Created

Event: Return created 

Response: Return 

URL: https://app.shipmonk.com/integrations/loop/webhook/create

4. For the second webhook:

Label Created

Event: Label created 

Response: Return 

URL: https://app.shipmonk.com/integrations/loop/webhook/label/create

5. Send Webhook Secret to ShipMonk. The Webhook Secret can be found below your active webhooks in your Loop admin.

6. Once you receive confirmation from ShipMonk, the integration is ready to use.

Automate marking RMA as Process

The Loop x ShipMonk integration also supports initiating return processing in Loop once the RMA is processed on ShipMonk.

To get this up and running ShipMonk needs to create and provide an API key.

1. In the Loop Admin head to Settings > Developers. 
2. Navigate to the API keys section and select Generate API key.
3. Select Order and Return as a scope and name the API key.

5. Send the API key to ShipMonk.
6. Once ShipMonk confirms that the integration is set up, processed RMAs should automatically process or flag returns in Loop.

Troubleshooting

Here is the list of things customer should do when Returns are not created in Shipmonk: 

1. Check that the webhook is active. 

2. Check that Event, URL and Response are set correctly. 

3. Check that items in the order are mapped correctly. 

4. If the points above did not help, contact ShipMonk.