Shopify Application Setup

Edited

With the Brilliant x Shopify integration, your Shopify Ecommerce site can be fulfilled by Brilliant. The integration will send orders from your Shopify Ecommerce store to Brilliant to be fulfilled, and any stock or fulfillment updates will be pushed to your Shopify site.

Prerequisites

Before setting up the integration, please ensure that the Shopify Ecommerce site you want to integrate with Brilliant uses the Shopify Grow plan or higher. The integration will not work with the Basic plan. Please also note that the person who sets up the Shopify store using the following instructions will need to be the owner of the store or will need to have the necessary permissions to complete the steps below.

The integration will associate each order with a single user in your Brilliant store. For this reason, we would recommend working with Brilliant to get a user created with a general email that you can use for this integration. We typically suggest creating a user email like ‘[email protected]’ that we can add as a user on the Brilliant end to set as the sender here. This email address will get notifications on orders if you’d like to monitor them, but this information is also available in your Brilliant dashboard.

Shopify User Permissions

The Shopify user who installs the app and sets up the integration will need to be the store owner or will need to have at least the following permissions under the "Store" role category:

Store permissions:

  • Orders

    • View

    • Fulfill and ship

    • Cancel

  • Products

    • View

    • Create and edit

    • Manage

  • Customers

    • View

  • Checkout and customer accounts

    • View and edit

  • Store settings

    • Manage settings

    • Shipping and delivery

    • Locations

  • Finance

    • Manage other payment settings

App and sales channel permissions:

  • Manage and install apps and channels

Install App

The first step to integrate Shopify with Brilliant is to install the Brilliant Fulfillment app in your Shopify store. The Brilliant Fulfillment app is what allows data to be synced to and from your store.

Brilliant will provide you with an install link for the app. Once you get the install link:

  1. Click the link to open the install page.

  2. Confirm the data requested by the app aligns with your expectations, then click Install.

After installing the app, you will be brought to the app's home page where you can configure your store and credentials to complete the connection.

Configure Credentials

Along with the install link, Brilliant will provide you with API credentials to connect Shopify to your Brilliant store. The user ID for the Brilliant user created in the Prerequisites will also be provided.

  1. In the navigation menu of the Brilliant Fulfillment Shopify app, click Settings.

  2. Enter the API key and Secret key, then click Save credentials.

    1. A success banner should show, indicating the credentials were saved and valid.

  3. Enter the User ID, then click Save user ID.

    1. A success banner should show, indicating the user ID was saved and valid.

Import Products

In order for Brilliant to sync orders with Shopify, the products/variants in the Shopify store must be configured in a specific way to be compatible with Brilliant. The SKU is what will be the common identifier between the products in Brilliant's system and the products in your Shopify store, and will serve as the source of truth between the two systems.

To easily import products from your Brilliant store into Shopify with all of the required settings already configured:

  1. Click Products in the navigation menu of the Brilliant Fulfillment Shopify app.

  2. Click Sync products.

This will populate Shopify with your Brilliant products and automatically set the following settings on each product. Please do not change any of these settings, as the integration relies on these values to work smoothly. Please also note that any product in your connected Shopify store that is fulfilled by Brilliant should only be fulfilled by Brilliant.

  • SKU: Corresponds to Brilliant ID

  • Track quantity: Checked

  • Continue selling when out of stock: Unchecked

  • Quantity: Only location listed is Brilliant's fulfillment service

Store Settings

Your Shopify store will need to be set up in a specific way to create a smooth integration experience. The app guides you through how to configure these settings:

  1. Click Store Setup in the navigation menu of the Brilliant Fulfillment Shopify app.

  2. Here you will see a list of items to be completed before you can test and go live with the integration. If you successfully completed the previous steps detailed in this document, the first 3 items should already be marked as Complete. For each item marked as Not verified:

    1. Read the instructions to see how to configure the specified setting.

    2. Click the Open *page* button to open the associated settings page of Shopify.

    3. Configure the setting as specified in the item instructions.

    4. Go back to the Store Setup page and click Mark as done for that item.

The store setting requirements from the app are also listed here.

  • Settings > General > Order processing > Select Automatically fulfill the order's line items

  • Settings > Payments > Payment configuration > Payment capture method > Select Automatically at checkout (your company is responsible for collecting customer payments)

  • Settings > Checkout

    • Customer contact method > Select Email

    • Customer information

      • Full name > Select Require first and last name

      • Shipping address phone number > Select Required

  • Settings > Shipping and delivery > Shipping

    • Click a shipping profile that includes the products fulfilled by Brilliant.

    • Scroll down until you see an option to Start shipping for the fulfillment service created by the Brilliant app.

    • Click Start shipping, then either use existing shipping options or create new shipping options depending on your use case.

    • Configure the rates as you wish, keeping in mind that Brilliant cannot sync calculated rates to Shopify. Your Brilliant contact can help you determine the best flat rate for your use case.

    • Click Done, then click Save.

    • Repeat these steps for each shipping profile that includes products fulfilled by Brilliant.

Place a Test Order

The final step to setting up the Shopify integration is placing a test order to ensure order data is syncing properly. With the store setup items above now completed, a Ready to test section should appear towards the top of the Store Setup page.

  1. On the Store Setup page, locate the Ready to test section.

  2. If you would like to test the notification emails sent from Shopify during the order fulfillment process, provide a test email address which you have access to. This email will get associated with the order. Otherwise, uncheck Mock shipping updates with notification emails.

    1. If you choose to provide an email address, keep in mind email notifications may take some time to be sent to your inbox.

  3. Click Place test order.

    1. This will create a test order in your Shopify store which you can see on the Orders page of your Shopify admin.