Skip to content

Settings

Contents 26 pages

Your quoting defaults, which emails and texts you get, the number alerts are texted to, your brand on ShipEasy's emails and tracking page, and your Refer & earn link: the same ones as Settings in the web app and in the ShipEasy app inside Shopify admin. Reading needs settings:read; changing needs settings:write. Web app organizations and Shopify stores both have them.

An organization's key makes each change as the member behind it, so the change shows under their name in the activity log.

Read and change settings#

GET/api/v1/settingsScope settings:read
PATCH/api/v1/settingsScope settings:write
Shell
curl https://app.shipeasyco.com/api/v1/settings \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"

emails and texts list every switch you have, each with a key, a label and whether it is on. PATCH changes only the fields you send; switches go in emails or texts as { "<key>": true }:

Shell
curl -X PATCH https://app.shipeasyco.com/api/v1/settings \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "insurance_default_on": true, "emails": { "bol_confirmation_enabled": false } }'

An organization's carriers narrows the carriers ShipEasy set up for it (an empty list means all of them); a store's names the carriers it quotes with. Either way they must come from available_carriers. A store's Shopify choices (auto_create_fulfillment, email_customer_on_ship, write_order_comment) are under store; an organization's key gets validation_failed for them. A store always keeps a notification_email.

Text alerts#

POST/api/v1/settings/text_alertsScope settings:write
POST/api/v1/settings/text_alerts/confirmScope settings:write
DELETE/api/v1/settings/text_alertsScope settings:write

Alerts can also go by text to one US or Canadian mobile number. POST /settings/text_alerts texts a code to it, and only when consent is true: send that once the person has read and agreed to text_alerts.consent_text from GET /settings, which is recorded with its version. POST /settings/text_alerts/confirm takes the code; DELETE stops texted alerts. Which alerts go by text is the texts switches.

Branding#

GET/api/v1/brandingScope settings:read
PATCH/api/v1/brandingScope settings:write
POST/api/v1/branding/test_emailScope settings:write
POST/api/v1/branding/reply_toScope settings:write
DELETE/api/v1/branding/reply_toScope settings:write
POST/api/v1/branding/tracking_domainScope settings:write
DELETE/api/v1/branding/tracking_domainScope settings:write
POST/api/v1/branding/tracking_domain/checkScope settings:write

PATCH /branding replaces the whole brand: name, color (#RRGGBB) and message; one left out or null goes back to ShipEasy's. POST /branding/logo takes a PNG, JPEG or WebP as image_base64 with its content_type; the request's size limit holds it to about 700 KB, so a bigger image goes through the web app. POST /branding/test_email sends a sample to test_email_to.

A reply-to address receives an email to confirm it is theirs, and customers' replies go there only after that; posting the same unconfirmed address again sends that email again. A tracking domain answers the records to add at your DNS provider; POST /branding/tracking_domain/check looks for them now. Each answers the brand as it now stands.

Referrals#

GET/api/v1/referralsScope settings:read

Your Refer & earn link to share, its terms, and the accounts that joined through it. While the program is off it answers 404 unknown_endpoint.

In an AI app#

The tools are get_settings, update_settings, set_up_text_alerts, confirm_text_alerts, remove_text_alerts, get_branding, update_branding, set_brand_logo, remove_brand_logo, send_brand_test_email, set_reply_to_email, remove_reply_to_email, set_tracking_domain, check_tracking_domain, remove_tracking_domain and get_referrals (AI agents).