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).
Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Headers
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.
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.
Body
The store's name.
What the store says about itself.
The currency its prices are in, as a three-letter code.
"USD"
Whether buyers are shown and charged prices in their own currency.
The store's colour, as #rrggbb.
"#6a3ce2"
The store's language and region, like en-GB or de-DE.
How few license keys a variant has left when the store is alerted.
Where buyers get help.
Where buyers find instructions.
A panel of the store's own that buyers sign in to.
The store's social networks: a network's name and its link. A blank link clears that network.
Links of the store's own, shown with its socials.
The store's terms, as text.
The store's refund policy, as text.
The store's logo, as "Get the store" answers it. Empty removes it.
The icon in the browser tab on the store's site. Empty removes it.
A password visitors have to enter to see the storefront. Empty opens it to everybody.
Whether the storefront shows how many of a variant are left.
Whether an order nobody reviewed is given five stars after seven days.
Whether the storefront shows items sold and customers.
Whether the storefront shows a note when somebody buys.
Whether the storefront shows how many visitors are on it.
Whether the store is open. Switched off, nothing can be bought.
What kind of business it is.
sole_proprietorship, partnership, llc, corporation, nonprofit, other The business's name, printed on invoices. With businessCountry, it opens Finance.
Its tax number.
Its VAT number.
The first line of its address.
The second.
Its city.
Its state or region.
Its postal code.
Its country, as a two-letter code.
"DE"
A line printed at the foot of every invoice.
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.
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.