Update a store

Replaces the specified store's data with the information in the form. Requires the stores.update permission.

storeIdstring uuid required

The ID of the store to update.

Request body

namestring required

The name of the store as shown on the users store page

descriptionstring required

The store description, shown on the store home page underneath the title

prependProductNameToReceiptboolean required

Whether the name of the product should be prepended to the start of delivery receipts to customers

currencyCodestring required

The ISO-compliant fiat currency code that is preferred for the store, defaults to USD

isAutomaticReviewsEnabledboolean required

Whether automatic review leaving is enabled

termsOfServiceUrlstring uri nullable

The URL to the store's terms of service page

refundPolicyUrlstring uri nullable

The URL to the store's refund policy page

privacyPolicyUrlstring uri nullable

The URL to the store's privacy policy page

isTicketingEnabledboolean required

Whether the built-in support ticket system is enabled for customers. When disabled, customers are directed to the external support URL instead.

externalSupportUrlstring uri nullable

The URL to direct customers to for external support when ticketing is disabled. Required when ticketing is disabled.

externalSupportDescriptionstring nullable

A description shown to customers explaining where to get support when ticketing is disabled.

showPublicStatsboolean required

Whether anonymized public statistics are shown to buyers on the storefront. Disabled by default for privacy.

showRecentOrderToastsboolean required

Whether recent order toast notifications are shown to visitors on the storefront. Disabled by default for privacy.

enableCartRecoveryboolean required

Whether abandoned cart recovery emails are enabled for this store. Requires email marketing credits. Disabled by default.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error