Skip to content

Get store settings

GET
/stores/{storeRef}/settings
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/settings \
--header 'x-api-key: <x-api-key>'

Returns the store’s settings: branding, social links, currency, order code prefix and suffix, legal links and the look of its emails. A store gets its settings when its setup finishes; before that the route answers 404 STORE_SETTINGS_NOT_FOUND.

Required scopes: read:settings

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
logo_url

Logo URL, or null.

string
nullable
tiktok_link

TikTok profile link, or null.

string
nullable
shopee_link

Shopee store link, or null.

string
nullable
google_analytics_key

Google Analytics tracking key, or null.

string
nullable
facebook_link

Facebook page link, or null.

string
nullable
instagram_link

Instagram profile link, or null.

string
nullable
favicon_url

Favicon URL, or null.

string
nullable
featured_image

Featured image URL, or null.

string
nullable
tagline

Store tagline, or null.

string
nullable
currency_code

Three-letter currency code of the store, such as VND.

string
nullable
email_preferences

Which roles receive which notification emails. A free-form object, or null.

object
key
additional properties
any
review_requests_enabled

Whether customers are asked for a product review after their order.

boolean
nullable
email_sender_name

Sender name shown on the store’s emails, or null for the default.

string
nullable
email_reply_to

Reply-to address of the store’s emails, or null.

string
nullable
attach_billing_documents

Whether the platform bill PDF is attached to billing emails.

boolean
nullable
order_number_prefix

Text placed before the order number in order codes, such as DH-. Null for none.

string
nullable
order_number_suffix

Text placed after the order number in order codes, such as -26. Null for none.

string
nullable
email_accent_color

Accent colour of email buttons and links as #RRGGBB, or null for the default.

string
nullable
email_bg_color

Email canvas background colour as #RRGGBB, or null for the default.

string
nullable
email_body_bg_color

Email content background colour as #RRGGBB, or null for the default.

string
nullable
email_text_color

Email text colour as #RRGGBB, or null for the default.

string
nullable
email_footer_text_color

Email footer text colour as #RRGGBB, or null for the default.

string
nullable
email_logo_url

Logo shown in email headers, or null to use logo_url.

string
nullable
email_header_tagline

Short line under the logo in email headers, or null.

string
nullable
email_footer_address

Postal address in the email footer, or null.

string
nullable
email_footer_phone

Phone number in the email footer, or null.

string
nullable
published_store_theme_id

ID of the store’s live theme, or null when none is published.

number
nullable
legal_links

Checkout and register links, or null.

object
terms

Link to the terms of service: a site path or a URL.

string
nullable
privacy

Link to the privacy policy: a site path or a URL.

string
nullable
created_at

When the settings were created, as an ISO 8601 timestamp.

string
nullable
updated_at

When the settings were last updated, as an ISO 8601 timestamp.

string
nullable
id
required

Settings record ID.

number

Example generated

{
"logo_url": "example",
"tiktok_link": "example",
"shopee_link": "example",
"google_analytics_key": "example",
"facebook_link": "example",
"instagram_link": "example",
"favicon_url": "example",
"featured_image": "example",
"tagline": "example",
"currency_code": "example",
"email_preferences": {},
"review_requests_enabled": true,
"email_sender_name": "example",
"email_reply_to": "example",
"attach_billing_documents": true,
"order_number_prefix": "example",
"order_number_suffix": "example",
"email_accent_color": "example",
"email_bg_color": "example",
"email_body_bg_color": "example",
"email_text_color": "example",
"email_footer_text_color": "example",
"email_logo_url": "example",
"email_header_tagline": "example",
"email_footer_address": "example",
"email_footer_phone": "example",
"published_store_theme_id": 1,
"legal_links": {
"terms": "example",
"privacy": "example"
},
"created_at": "example",
"updated_at": "example",
"id": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}