Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

FAQ

General

Can I use Elements for my mobile app or mobile responsive site?

  • Elements is not built for direct integration with native mobile apps (iOS/Android). However, it is optimized for responsive design and works effectively with viewports as narrow as 440px.

What steps is ShipEngine Elements taking to meet web accessibility standards?

  • We are dedicated to making Elements accessible to all users, including those with disabilities. Our goal is to meet both Level AA and Level AAA standards of the Web Content Accessibility Guidelines (WCAG). We are continually enhancing the user experience by addressing accessibility challenges and adhering to best practices. If you experience any difficulties while using our app, please reach out to us. We are committed to making the necessary adjustments to ensure an inclusive and smooth experience for everyone.

What are the required peer dependencies for Elements NPM Packages?

1
npm install [email protected] [email protected] [email protected] [email protected] @emotion/[email protected]

ShipEngine Prerequisites

How do I generate a ShipEngine seller account?

How do I generate shipments to purchase labels for?

What is a warehouse and how do I create seller warehouses (Ship From Locations)?

  • Please refer to the Warehouse documentation for detailed information.

Onboarding Element

I’ve already set up a ShipEngine Seller using the Partners API. Does this seller still need to use the Onboarding Element?

  • After successfully setting up a ShipEngine Seller via the Partners API, it is recommended to navigate the seller through the Onboarding Element to finalize setup before purchasing labels. This step is essential for accessing competitive rates through our ShipEngine Carrier accounts.

The following steps are required in the Onboarding Element to connect ShipEngine Carrier accounts:

  • Set a default Ship-From Address: For accurate shipping calculations.
  • Agree to Terms of Service: To comply with ShipEngine's policies.
  • Provide a Payment Method: To connect to ShipEngine Carrier Accounts and access competitive rates.

Purchase Label Element

How can I browse Service Points / Pick Up Drop Off Locations when rate shopping?

We have introduced a feature that allows sellers to browse service point locations for select UK ShipEngine carriers (Hermes, Yodel, and DPD). By default, when calculating rates in the Purchase Label Element with these carriers enabled, service points will be displayed under the relevant rate if they are available within a 10km radius of the shipment's origin location.

To access our feature-rich Pick Up Drop Off UI, which includes an interactive map of service points, ensure that the enablePudoUI feature is set to true in the Purchase Label Element.

1
2
3
purchaselabelFeatures: {
      rateForm: { enablePudoUI: true },
  }

For a comprehensive overview of available features, please refer to the Purchase Label Features section.