Skip to main content

ShipEngine

ShipEngine gives e-commerce store owners more robust data about their product shipments. This guide walks you through connecting ShipEngine to your TakeShape project.

Don't have a project yet? Check out this guide for setting one up.

Getting a ShipEngine API key

After signing up for a ShipEngine account, navigate to your ShipEngine API Dashboard and choose an API you want to use. You can select API Management on the left, then select the Create New Key button to generate a new key. However if you're using a free account for this tutorial, you'll need to create a free Sandbox API Key.

Select the Sandbox tab on the left of your dashboard. There should already be an API Key generated, but you can generate a new one instantly by selecting Create New Key on this page. Your Sandbox API Key will begin with TEST_. Copy this key to put into your TakeShape project.

Remember

Updating your ShipEngine account from Sandbox to production will require you to update your API Key in TakeShape. Your production API Key will not have the TEST_ prefix.

Connecting ShipEngine to TakeShape

Now navigate to your TakeShape project's dashboard in the web client and select ShipEngine under the services list.

Give the service a Name (for example ShipEngine Sandbox). The Slug and Namespace will automatically adjust to the Name you set.

Under Authentication, set the API Key to the key you generated on your API Dashboard in ShipEngine.

Select Save in the top right of your screen, and your service will be connected.

To query ShipEngine immediately, hover over ShipEngine in your Patterns & Services panel on the left and select the three dots that appear. Select Configure Queries & Mutations and select a query to add to the API. For example, listShipments will list all shipments from your store.

Once you add the query to your schema, you can run it in your API Explorer panel.

{
ShipEngine_listShipments {
shipments {
items {
sales_order_id
}
}
}
}

Still need help? Get in touch with us.