Update a store
const url = 'https://apibase.ecomweb.app/api/v1/stores/example';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"My Awesome Store","description":"A great store selling amazing products","subdomain":"my-awesome-store","custom_domain":"mystore.com","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","featured_image":"https://example.com/featured.jpg","tagline":"Quality products, great prices"}'};
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 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "My Awesome Store", "description": "A great store selling amazing products", "subdomain": "my-awesome-store", "custom_domain": "mystore.com", "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", "featured_image": "https://example.com/featured.jpg", "tagline": "Quality products, great prices" }'Changes the store’s name and description. The other fields in the body pass validation but are not applied; use the store settings routes for branding and links. An unknown store reference returns 404. Public store data is refreshed right away.
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
Name of the store
Example
My Awesome StoreDescription of the store
Example
A great store selling amazing productsAccepted but not applied: the subdomain is not changed through this route. Lowercase letters, numbers and hyphens.
Example
my-awesome-storeCustom domain for the store
Example
mystore.comLogo 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-XFeatured image URL for the store
Example
https://example.com/featured.jpgStore tagline
Example
Quality products, great pricesResponses
Section titled “Responses”object
Store description, or null.
pending while the store is being set up, active, or disabled by the merchant.
Progress flags of the store’s setup, such as product_added and theme_customized.
object
Deletion time as an ISO 8601 timestamp, or null. Deleted stores are not returned, so this is normally null.
When the store was first opened to the public, as an ISO 8601 timestamp. Null until then.
When the merchant ended setup without opening the store, as an ISO 8601 timestamp, or null.
The store’s settings. Present only when include_settings is set; null when the store has none yet.
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.
The store’s domain configuration. Present only when include_config is set; null when it has none yet.
object
The store’s subdomain on the platform domain, or null.
The store’s custom domain in lower case, or null.
Whether the custom domain is verified. It serves the store only when it is.
The value the merchant publishes in DNS to prove they own the custom domain. Put it in
a TXT record named _ecomweb-verify.<domain> as ecomweb-verify=<token>. Null until a
custom domain is claimed.
When the current custom domain was claimed, as an ISO 8601 timestamp, or null.
When a verified domain’s DNS record was last re-checked, as an ISO 8601 timestamp, or null.
Set while a verified domain’s DNS record is missing: the domain is released at this time. Null otherwise.
When the configuration was created, as an ISO 8601 timestamp.
When the configuration was last updated, as an ISO 8601 timestamp.
The store’s plan. Present only on the list and only when include_subscription is set.
object
Name of the plan, or null.
When the trial ends, as an ISO 8601 timestamp, or null.
When the current billing period ends, as an ISO 8601 timestamp, or null.
Subscription status, such as active.
True for the free plan. A free store still has an active subscription.
True on the trial plan every new store starts on.
The caller’s role in the store, such as owner. Present only on the list.
The store’s reference, used as storeRef in every other route.
ID of the account that owns the store.
Store name.
Whether the store has already used its free trial.
When the store was created, as an ISO 8601 timestamp.
When the store was last updated, as an ISO 8601 timestamp.
Whether visitors see the coming soon page instead of the storefront.
Whether the setup guide is hidden in the dashboard.
Example
{ "status": "pending"}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"}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"}