Update store settings
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/settings';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"logo_url":"https://example.com/logo.png","favicon_url":"https://example.com/favicon.ico","tiktok_link":"https://tiktok.com/@mystore","shopee_link":"https://shopee.vn/mystore","facebook_link":"https://facebook.com/mystore","instagram_link":"https://instagram.com/mystore","google_analytics_key":"GA-XXXXXXXXX-X","shop_introduction":"example","theme_config":{},"featured_image":"https://example.com/featured.jpg","tagline":"Quality products, great prices","currency_code":"VND","review_requests_enabled":true,"attach_billing_documents":false,"order_number_prefix":"DH-","order_number_suffix":"-26","legal_links":{"terms":"/pages/terms-of-service","privacy":"/pages/privacy-policy"},"email_accent_color":"#f4644f","email_bg_color":"#FFFFFF","email_body_bg_color":"#FFFFFF","email_text_color":"#1A1A1A","email_footer_text_color":"#6B7280","email_logo_url":"https://example.com/email-logo.png","email_header_tagline":"Style for everyone","email_footer_address":"123 Nguyen Hue, District 1, HCMC","email_footer_phone":"1900-1234"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/settings \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "logo_url": "https://example.com/logo.png", "favicon_url": "https://example.com/favicon.ico", "tiktok_link": "https://tiktok.com/@mystore", "shopee_link": "https://shopee.vn/mystore", "facebook_link": "https://facebook.com/mystore", "instagram_link": "https://instagram.com/mystore", "google_analytics_key": "GA-XXXXXXXXX-X", "shop_introduction": "example", "theme_config": {}, "featured_image": "https://example.com/featured.jpg", "tagline": "Quality products, great prices", "currency_code": "VND", "review_requests_enabled": true, "attach_billing_documents": false, "order_number_prefix": "DH-", "order_number_suffix": "-26", "legal_links": { "terms": "/pages/terms-of-service", "privacy": "/pages/privacy-policy" }, "email_accent_color": "#f4644f", "email_bg_color": "#FFFFFF", "email_body_bg_color": "#FFFFFF", "email_text_color": "#1A1A1A", "email_footer_text_color": "#6B7280", "email_logo_url": "https://example.com/email-logo.png", "email_header_tagline": "Style for everyone", "email_footer_address": "123 Nguyen Hue, District 1, HCMC", "email_footer_phone": "1900-1234" }'Changes the settings you send and leaves the rest as they are, creating the settings if the store has none yet. Public store data and the store’s email branding are refreshed right away. A new order prefix or suffix applies only to orders placed afterwards; existing orders keep their codes. Colours are #RRGGBB. Sending shop_introduction or theme_config fails with 400: those are theme settings now.
Required scopes: write:settings
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Logo URL for the store
Example
https://example.com/logo.pngFavicon URL for the store
Example
https://example.com/favicon.icoTikTok profile link
Example
https://tiktok.com/@mystoreShopee store link
Example
https://shopee.vn/mystoreFacebook page link
Example
https://facebook.com/mystoreInstagram profile link
Example
https://instagram.com/mystoreGoogle Analytics tracking key
Example
GA-XXXXXXXXX-XRetired. A theme setting now: PATCH /stores/:ref/themes/:id settings_values. Sending it returns 400.
Retired. Theme values live on store themes: PATCH /stores/:ref/themes/:id settings_values. Sending it returns 400.
object
Featured image URL for the store
Example
https://example.com/featured.jpgStore tagline
Example
Quality products, great pricesCurrency code for the store
Example
VNDEnable product review requests after order completion
Example
trueAttach the platform bill PDF to billing emails. Off by default: attachments raise spam scoring, and the email links to the document either way.
Example
falsePrefix wrapped around the order sequence to form the customer-facing order code. Frozen onto each order at placement, so changing it never renames an existing order.
Example
DH-Suffix wrapped around the order sequence to form the customer-facing order code. Frozen onto each order at placement.
Example
-26Checkout and register links: { terms, privacy }
object
Link to the terms of service: a site path or a URL. At most 500 characters.
Link to the privacy policy: a site path or a URL. At most 500 characters.
Example
{ "terms": "/pages/terms-of-service", "privacy": "/pages/privacy-policy"}Accent colour for email buttons and links
Example
#f4644fEmail canvas background colour
Example
#FFFFFFEmail content background colour
Example
#FFFFFFHeading and body text colour
Example
#1A1A1ASecondary and footer text colour
Example
#6B7280Logo shown in email headers. Falls back to logo_url.
Example
https://example.com/email-logo.pngShort line shown under the logo in email headers
Example
Style for everyonePostal address shown in the email footer
Example
123 Nguyen Hue, District 1, HCMCPhone number shown in the email footer
Example
1900-1234Responses
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 request is malformed or failed validation.
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 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"}