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.

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:

PropertyTypeDescription
namestringRequired
The name of the theme
Max 50 characters
logo.content_typeimage/jpeg
image/png		Image content type
logo.image_datastringbase64 encoded
brandstringRequired
Brand name that appears on the Start screen
return_urlstringURL to return to upon logout
Max 1000 characters
onboarding.start_titlestringMax 50 characters
onboarding.start_textstringMax 1000 characters
onboarding.complete_titlestringMax 50 characters
onboarding.complete_textstringMax 1000 characters
onboarding.complete_button_textstringMax 50 characters
onboarding.complete_close_buttonbooleanDefault = false
Determines whether to display the close button or not (see Customize Onboarding for behavior details)
onboarding.complete_close_button_textstringMax 50 characters
onboarding.skip_shipstation_api_carriersbooleanDefault = false
Determines whether to skip the set up for ShipStation API resell carriers
carriers.connect_country_codesArray of stringsDetermines 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_idstringuuid
created_atstringdate-time
modified_atstringdate-time