Skip to content
Integrations
SaaS Integrations
ShipHero

ShipHero

This Integration requires Fides Cloud or Fides Enterprise. For more information, talk to our solutions team. (opens in a new tab)

ShipHero (opens in a new tab) is a warehouse management and fulfillment platform that handles order fulfillment, shipping labels, returns, and inventory for eCommerce brands and third-party logistics (3PL) providers.

Prerequisites

In order to integrate with ShipHero, you'll need to collect the following information:

NameDescription
Domain*The ShipHero Public API (default: public-api.shiphero.com).
Refresh token*The refresh token issued when you add a Third-Party Developer user. Follow ShipHero's docs to add a third-party developer (opens in a new tab).

Obtaining a refresh token

ShipHero issues API credentials to a dedicated Third-Party Developer user, so you never need to share a ShipHero account password with Astralis:

  1. Log into the ShipHero dashboard and navigate to My Account → Developer Users.
  2. Click Add Third-Party Developer and complete the details for the new user.
  3. ShipHero displays a Bearer Token and a Refresh Token for that user. Copy the Refresh Token.

Astralis only needs the refresh token. Access tokens issued by ShipHero expire after 28 days, and Astralis exchanges the refresh token for a new access token automatically, so no periodic credential rotation is required on your side.

If you operate as a 3PL with several customer accounts, add the Third-Party Developer user on the ShipHero account that holds the data in scope for the privacy request.

Integrating with ShipHero

To integrate an existing system with ShipHero:

  1. Navigate to Data map → View Systems and choose the system that you want to connect.
  2. Click on the Integrations tab.
  3. Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
  4. Complete the required fields for the integration and click Save.

You may confirm your connection is working using the Test connection button, if desired.

To learn more, please see our guide for Managing Integrations.

Technical detail

Astralis utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Astralis can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.

ShipHero exposes a single GraphQL endpoint rather than a set of REST paths, so each row in the table below is a GraphQL query. Astralis resolves the data subject by email address using the orders query, then follows the resulting order IDs to every other collection — none of the remaining queries accept an email filter of their own.

ShipHero endpoints

In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.

Privacy functionEndpointDescription
Access RequestsOrders (opens in a new tab)Returns orders matched by email address, including the shipping and billing addresses.
Access RequestsOrder (opens in a new tab)Returns the line items on each matched order, including any personalization options.
Access RequestsOrder History (opens in a new tab)Returns the change history for each matched order, including superseded address and email values.
Access RequestsShipments (opens in a new tab)Returns shipments for each matched order, along with the shipping labels and packing slips.
Access RequestsReturns (opens in a new tab)Returns return records for each matched order, including the return address and returned items.
Access RequestsOrder attachments (opens in a new tab)Returns documents attached to each matched order, such as customs paperwork.
Access RequestsOrder RMA labels (opens in a new tab)Returns return merchandise authorization (RMA) labels for each matched order, including the recipient name and address.
ServiceNow ITSMShopify