Themes Reference | ShipEngine

🎉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.

Themes Endpoint Reference

The themes endpoint let's you customize your customer's onboarding experience with your preferred branding as well as set which country's carriers your customers can connect to.

Theme Properties Reference

The following properties are available with the themes endpoint:

Property Type Description
name string Required
The name of the theme
Max 50 characters
logo.content_type image/jpeg
image/png		 Image content type
logo.image_data string base64 encoded
brand string Required
Brand name that appears on the Start screen
return_url string URL to return to upon logout
Max 1000 characters
onboarding.start_title string Max 50 characters
onboarding.start_text string Max 1000 characters
onboarding.complete_title string Max 50 characters
onboarding.complete_text string Max 1000 characters
onboarding.complete_button_text string Max 50 characters
onboarding.complete_close_button boolean Default = false
Determines whether to display the close button or not (see Customize Onboarding for behavior details)
onboarding.complete_close_button_text string Max 50 characters
onboarding.skip_shipstation_api_carriers boolean Default = false
Determines whether to skip the set up for ShipStation API resell carriers
carriers.connect_country_codes Array of strings Determines which countries carriers are available to connect to the account.
Use the two-letter ISO 3166-1 country codes where the first country code is the country code of the account.
theme_id string uuid
created_at string date-time
modified_at string date-time