> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Update the store > Saves the store's settings. Read the store first and send it back changed: `name` is needed, and `description`, `logoUrl`, `supportUrl`, `guideUrl` and `panelUrl` are cleared when left out. Every other field stays as it is when left out. The store's address is changed with "Change the store's address", and its logo and icon are uploaded with their own routes. Needs the `store.write` permission (Change Store). ## OpenAPI ````yaml /api-reference/openapi.json put /stores/{storeId} openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}: put: tags: - Store summary: Update the store description: >- Saves the store's settings. Read the store first and send it back changed: `name` is needed, and `description`, `logoUrl`, `supportUrl`, `guideUrl` and `panelUrl` are cleared when left out. Every other field stays as it is when left out. The store's address is changed with "Change the store's address", and its logo and icon are uploaded with their own routes. Needs the `store.write` permission (Change Store). operationId: store.update parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The store's name. description: type: string description: What the store says about itself. currencyCode: type: string description: The currency its prices are in, as a three-letter code. example: USD adaptivePricing: type: boolean description: >- Whether buyers are shown and charged prices in their own currency. accentColor: type: string description: The store's colour, as `#rrggbb`. example: '#6a3ce2' locale: type: string description: The store's language and region, like `en-GB` or `de-DE`. lowStockThreshold: type: integer description: >- How few license keys a variant has left when the store is alerted. supportUrl: type: string description: Where buyers get help. guideUrl: type: string description: Where buyers find instructions. panelUrl: type: string description: A panel of the store's own that buyers sign in to. socialLinks: type: object description: >- The store's social networks: a network's name and its link. A blank link clears that network. example: discord: https://discord.gg/example customLinks: type: array description: Links of the store's own, shown with its socials. items: type: object properties: label: type: string description: What it says. url: type: string description: Where it leads. icon: type: string description: The icon drawn beside it. required: - label - url termsOfService: type: string description: The store's terms, as text. refundPolicy: type: string description: The store's refund policy, as text. logoUrl: type: string description: >- The store's logo, as "Get the store" answers it. Empty removes it. faviconUrl: type: string description: >- The icon in the browser tab on the store's site. Empty removes it. storefrontPassword: type: string description: >- A password visitors have to enter to see the storefront. Empty opens it to everybody. publishStock: type: boolean description: Whether the storefront shows how many of a variant are left. autoReviews: type: boolean description: >- Whether an order nobody reviewed is given five stars after seven days. publicStats: type: boolean description: Whether the storefront shows items sold and customers. saleNotifications: type: boolean description: Whether the storefront shows a note when somebody buys. publicOnline: type: boolean description: Whether the storefront shows how many visitors are on it. active: type: boolean description: >- Whether the store is open. Switched off, nothing can be bought. businessType: type: string description: What kind of business it is. enum: - sole_proprietorship - partnership - llc - corporation - nonprofit - other businessName: type: string description: >- The business's name, printed on invoices. With `businessCountry`, it opens Finance. businessTaxId: type: string description: Its tax number. businessVatNumber: type: string description: Its VAT number. businessLine1: type: string description: The first line of its address. businessLine2: type: string description: The second. businessCity: type: string description: Its city. businessRegion: type: string description: Its state or region. businessPostalCode: type: string description: Its postal code. businessCountry: type: string description: Its country, as a two-letter code. example: DE invoiceFooter: type: string description: A line printed at the foot of every invoice. expectedVersion: type: string description: >- The `settingsVersion` you last read. Sent, the change is refused with `stale_write` only if something this route saves has changed since; the store's other settings (Support Tickets on or off, its tax, its payment options and the like) changing is not that. Use it rather than `expectedUpdatedAt`, which every one of them moves. expectedUpdatedAt: type: string description: >- The `updatedAt` you last read. Sent, the change is refused with `stale_write` if the record has changed since. Left out, it is saved whatever happened in between. required: - name responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string name: type: string slug: type: string urlChangeableAt: nullable: true supportUrl: type: string guideUrl: type: string panelUrl: type: string socialLinks: type: object properties: discord: type: string youtube: type: string tiktok: type: string x: type: string instagram: type: string telegram: type: string customLinks: type: - array - object description: type: string currencyCode: type: string adaptivePricing: type: boolean currencies: type: array items: type: object properties: code: type: string name: type: string ratesFetchedAt: type: string locale: type: string logoUrl: nullable: true faviconUrl: nullable: true storefrontPassword: type: string storefrontPasswordUnreadable: type: boolean accentColor: type: string theme: type: string publishStock: type: boolean lowStockThreshold: type: integer dashboardCards: type: array items: type: string termsOfService: type: string refundPolicy: type: string autoReviews: type: boolean publicStats: type: boolean saleNotifications: type: boolean publicOnline: type: boolean active: type: boolean blocked: nullable: true businessType: type: string businessName: type: string businessTaxId: type: string businessVatNumber: type: string businessLine1: type: string businessLine2: type: string businessCity: type: string businessRegion: type: string businessPostalCode: type: string businessCountry: type: string invoiceFooter: type: string originCountry: type: string hasDynamicSecret: type: boolean dynamicSecretEnd: type: string updatedAt: type: string settingsVersion: type: string example: success: true message: null code: null data: id: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7 name: Northwind Keys slug: northwind urlChangeableAt: null supportUrl: https://example.com/support guideUrl: '' panelUrl: '' socialLinks: discord: '' youtube: '' tiktok: '' x: '' instagram: '' telegram: '' customLinks: [] description: Software licences, delivered at once. currencyCode: USD adaptivePricing: false currencies: - code: AED name: UAE dirham - code: ARS name: Argentine peso ratesFetchedAt: '2026-09-29T06:00:05Z' locale: en-US logoUrl: null faviconUrl: null storefrontPassword: '' storefrontPasswordUnreadable: false accentColor: '#6a3ce2' theme: simplistic publishStock: true lowStockThreshold: 5 dashboardCards: - conversion - status termsOfService: '' refundPolicy: '' autoReviews: true publicStats: false saleNotifications: false publicOnline: true active: true blocked: null businessType: '' businessName: Northwind Keys Ltd businessTaxId: '' businessVatNumber: '' businessLine1: '' businessLine2: '' businessCity: '' businessRegion: '' businessPostalCode: '' businessCountry: DE invoiceFooter: '' originCountry: '' hasDynamicSecret: true dynamicSecretEnd: 1g== updatedAt: '2026-10-22T16:20:18.564Z' settingsVersion: 39fb4e12852a97ad249eb904 '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.store.update({ name: "...", }); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->store->update([ 'name' => '...', ]); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.store.update(name="...") components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.