Get store settings
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/settings';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
Logo URL, or null.
TikTok profile link, or null.
Shopee store link, or null.
Google Analytics tracking key, or null.
Facebook page link, or null.
Instagram profile link, or null.
Favicon URL, or null.
Featured image URL, or null.
Store tagline, or null.
Three-letter currency code of the store, such as VND.
Which roles receive which notification emails. A free-form object, or null.
object
Whether customers are asked for a product review after their order.
Sender name shown on the store’s emails, or null for the default.
Reply-to address of the store’s emails, or null.
Whether the platform bill PDF is attached to billing emails.
Text placed before the order number in order codes, such as DH-. Null for none.
Text placed after the order number in order codes, such as -26. Null for none.
Accent colour of email buttons and links as #RRGGBB, or null for the default.
Email canvas background colour as #RRGGBB, or null for the default.
Email content background colour as #RRGGBB, or null for the default.
Email text colour as #RRGGBB, or null for the default.
Email footer text colour as #RRGGBB, or null for the default.
Logo shown in email headers, or null to use logo_url.
Short line under the logo in email headers, or null.
Postal address in the email footer, or null.
Phone number in the email footer, or null.
ID of the store’s live theme, or null when none is published.
Checkout and register links, or null.
object
Link to the terms of service: a site path or a URL.
Link to the privacy policy: a site path or a URL.
When the settings were created, as an ISO 8601 timestamp.
When the settings were last updated, as an ISO 8601 timestamp.
Settings record ID.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}