Blue Cherry Integration
OVERVIEW
BlueCherry by CGS is an enterprise resource planning and supply chain management platform that provides consumer lifestyle brands with tools and software to help manage end-to-end operations. This article explains what is needed to set up Loop's native BlueCherry integration and how to test it.
Use the menu on the left to quickly navigate this article.
This article covers Loop's native BlueCherry integration, which Loop owns and maintains. BlueCherry provides the merchant with the setup information below so Loop can configure the connection.
Important: The lead time on setup for this integration is ONE MONTH from when Loop receives the information below. It is a complicated integration to setup that requires manual engineering work and testing.
Qualifications
Merchant must be able to use BlueCherry APIs. If they are not able to, they need to reach out to their BlueCherry rep to set this up prior to reaching out to Loop.
Merchant's RMA creation API endpoint must be able to accept a
ref_num2field, which will house Loop's return ID, and the OrderReturn and OrderReturnDetails endpoints must be able to return it in the payload. Please verify this with BlueCherry.Merchant must have a Shopify dev instance with a Loop sandbox instance for testing.
If you need assistance setting up a Loop instance for your Shopify dev site, please reach out to your Onboarding Specialist.
Setup
The following information will need to be provided to your Onboarding Specialist in order for Loop to initiate setting up the integration.
The merchant or BlueCherry needs to provide Loop with the following credentials:
API Keys to access BlueCherry APIs
API URL endpoint including staging and production codes
e.g. staging -
https://examplebcapi.azure-api.net/EXAMPL/EXTEe.g. production -
https://examplebcapi.azure-api.net/EXAMPL/EXPR
Choose processing flow:
Return is processed based on Loop return policy outcomes
Default - No additional setup required
Return is processed when the return is processed in BlueCherry (return policy processing outcome is manual)
Polling will be enabled to retrieve item detail stage updates from BlueCherry for processing
Processing stage needs to be included in setup instructions
Provide Loop with payload mapping details:
The Loop Return ID must be passed into an unused field so the merchant can store it as reference.
We will use the
ref_num2field
Return tracking numbers can be sent & also need to be passed to an unused field
Example: route the tracking number to the
aux_ref_numfieldGenerate labels must be enabled on your return policies
Confirm if you want the UPC passed into each line item's
upcfield.Align on & communicate any exceptions to Loop. For example, do you need the SKU of the item in the same field?
Provide return reason mapping:
Ensure Loop return reasons are up to date
Return reasons can be found in the Loop Admin (Returns Management > Shopper Experience > Return reasons)
You can view an example of return reasons and corresponding codes at the bottom of this article. Please revise to use the return reasons specific to your shop.
Note: Whenever new return reasons are added to your shop, these will need to be added manually as well to your setup. Reach out to support@loopreturns.com with your updated return reasons and their mapping codes.
Note: Once all the information above has been gathered, please send it to your Loop Onboarding Specialist. From there, we will pass this information to the engineering team to complete the setup. Again, this is a complicated integration to execute so it may take a few weeks to confirm the completion of the setup.
Testing
Testing and validating this integration is the merchant's responsibility, in partnership with BlueCherry. Loop does not have access to your BlueCherry admin, so you'll need to work with your BlueCherry team to confirm the return data landing in BlueCherry looks correct.
Validate the RMA is created in BlueCherry and the data values are accurate.
If you are processing by outcome, make sure you test a return with each outcome.
If you are processing by BlueCherry stage, validate the return is processed when BlueCherry updates the item detail stage for each item. This will not be instant, as we are using polling to check for updates.
Note: Loop creates RMAs in BlueCherry when a return is initiated. Loop does not cancel or close RMAs in BlueCherry — any cancellation or closeout must be handled directly in BlueCherry.
Category | SubCategory | Reason Code |
|---|---|---|
Item didn't fit | ||
Item was too big | C21 | |
Item was too small | C20 | |
I didn't like the item | ||
I didn't like how the item looked | C22 | |
I didn't like the fabric | C24 | |
I didn't like the color | C23 | |
I changed my mind | ||
I found something else I like more | C25 | |
I liked a different item instead | C22 | |
I liked a different brand instead | C25 | |
It wasn't worth the price | C25 | |
Item arrived too late | C33 | |
Item was damaged | ||
Item was damaged when it arrived | C16 | |
Monogram was defective | C32 | |
Monogram was missing | C32 | |
Other | C16 | |
I received the wrong item | ||
Right item, but in the wrong size | C26 | |
Right item, but in the wrong style | C26 | |
I received the wrong product | C26 | |
I ordered multiple sizes of same item | C27 | |
Item not as described | C13 | |
Other (Catch-all if nothing ties out above) | C28 |
Please reach out to support@loopreturns.com with any additional questions.
