Back to Medusa

{metadata.title}

www/apps/bloom/app/prompting/service-integrations-prompting/guides/shipstation/page.mdx

2.14.23.7 KB
Original Source

export const metadata = { title: ShipStation Integration, }

{metadata.title}

Add ShipStation to manage shipping and fulfillment in your Bloom store.

ShipStation connects to your carriers and helps you provide dynamic shipping options, calculate shipping costs at checkout, and fulfill orders efficiently.

Prerequisites

Before adding ShipStation, you need a ShipStation account.

You also need to enable carriers in your account. To do that:

  1. On the Onboard page, in the "Enable carriers & see rates" section, click the "Enable Carriers" button.
  2. In the pop-up that opens, click Continue Setup.
  3. Enter your payment details and billing address, then click Continue Setup.
  4. Check the boxes on the Terms of Service section, then click Finish Setup.
  5. If you're not US-based, disable ParcelGuard insurance to avoid errors when getting shipping rates.

Then, you need to add carriers to your account. To do that:

  1. On the Onboard page, in the "Enable carriers & see rates" section, click on the "Add your carrier accounts" link.
  2. Click on a provider from the pop-up window. For example, UPS.
  3. Follow the instructions to connect your carrier account to ShipStation. The instructions vary based on the carrier.

Finally, activate the Shipping API and get an API key. To do that:

  1. Go to Add-Ons from the navigation bar.
  2. Find Shipping API and activate it.
  3. Click the cog icon in the navigation bar to go to Settings.
  4. In the sidebar, expand Account, then click API Settings.
  5. On the API Settings page, make sure V2 API is selected for "Select API Version", then click "Generate API Key".

You'll use the API key you generated when Bloom asks for it.


Add ShipStation to Your Store

Ask Bloom to add ShipStation with details about how you want shipping to work. For example:

bash
Add ShipStation as a fulfillment provider for my store. Show shipping
options from my carriers configured in ShipStation. Calculate shipping rates
at checkout based on the customer's shipping address and the products in their cart.

Bloom will set up ShipStation as the fulfillment provider for your store and configure it based on your requirements.


Enter Your ShipStation Credentials

When Bloom asks, enter your ShipStation API key.

Bloom stores this key securely and uses it to connect your store to ShipStation.

<Note title="Technical Information">

Bloom stores your ShipStation credentials as environment variables in your store. They are never exposed in your code or logs. See Environment Variables for more details.

</Note>

Test ShipStation

After Bloom adds ShipStation, test checkout in your preview store. Check that shipping options show up based on the customer's address and the products in their cart.

Make sure the shipping rates at checkout match the rates in your ShipStation account.


Publish ShipStation Integration

Once you've tested the integration and you're ready to go live, you can publish your changes with your live credentials.

To publish the changes:

  1. Click on the "Publish" button at the top right.
  2. If you haven't published your store before, Bloom will ask you for some details about your store.
  3. In the "Missing production values" section, enter the live credentials for ShipStation. You can use the same keys if you don't have separate ones for testing and production.
  4. Click "Publish" to make your changes live.

Your ShipStation integration will be published to your live store, and customers can start using it in the checkout flow.


Need Help?

If you face any issues while adding ShipStation to your Bloom store, contact support or submit feedback.