Update the current store
Updates the current store configuration.
Required scope: write_settings (for API-key authentication).
Authorizations
Secret API key for admin access
JWT token for admin user authentication
Headers
Bearer token for admin authentication
Body
"My Store"
"en"
"Europe/Berlin"
g, kg, lb, oz metric, imperial The store-wide default for what anonymous visitors can see. Channels fall back to it when they don't set their own.
public, prices_hidden, login_required The storefront's public URL, the base for links in customer emails. Saving it also completes the storefront setup task.
The store-wide default for guest checkout. Channels fall back to it.
Always show a confirmation step in checkout, even when no payment method requires one.
Shows a company field on address forms.
Makes a company name mandatory on addresses.
Makes a phone number mandatory on customer addresses.
The store-wide default for when a customer is charged rather than only authorized. A payment method's own setting wins when set.
checkout, on_dispatch, manual Counts on-hand quantities. Off means everything is treated as always available.
Holds stock for shoppers while they check out, so the same item can't be sold twice.
On-hand units at or below which a tracked variant counts as low stock on the home screen; 0 turns the warning off.
Calculates tax from the shipping address. When false, tax is calculated from the billing address.
Records price changes for the EU Omnibus lowest-price-in-30-days display.
Whether products with no price in the shopper's currency still appear in listings.
Lets more than one variant share the same SKU.
The store-wide order routing strategy shorthand. Channels fall back to it.
Where prices come from: a registered provider key, or internal.
Where stock levels come from: a registered provider key, or internal.
strict refuses to price when the provider cannot answer; fallback uses the catalog.
fallback, strict fallback sells on the local stock snapshot when the provider cannot answer; strict refuses.
fallback, strict Blank means the built-in provider: the marketplace settles by hand.
daily, weekly, biweekly, monthly, manual In the store's currency.
^-?\d+(\.\d+)?$"50.00"
Admits a seller as soon as they finish onboarding, with no operator review.
Puts a seller product on sale the moment it is submitted, with no review.
When false, transactional seller emails (approval, payouts and so on) are not sent.
Tax charged on commission as a fraction ("0.23" is 23%), when neither the commission rate nor the tax provider names one.
^-?\d+(\.\d+)?$"0.23"
How document numbers are produced: sequential or random. Applies to every numbered document.
"sequential"
Leads every order number. Uppercase letters, digits, dashes and # only.
"R"
Ends every order number. Uppercase letters, digits, dashes and # only.
The first sequential order number. Only applies before the store's first order.
Whether a digital download link stops working after a number of clicks.
How many clicks a download link allows, unless the file sets its own.
Whether a digital download link expires after a number of days.
How many days a download link stays valid, unless the file sets its own.
Sender address of every transactional email.
Customer-facing reply-to address shown in the storefront and email footers.
Recipient of "new order placed" staff notifications.
When false, transactional customer emails (order confirmation and so on) are not sent.
Customer email buttons and links, as #RRGGBB. Blank keeps the outlined buttons emails ship with.
Customer email page background, as #RRGGBB.
Customer email card behind the content, as #RRGGBB.
Customer email body text, as #RRGGBB.
Customer email headings and emphasized text, as #RRGGBB.
Customer email font: inter, system, helvetica, georgia, roboto, lato or merriweather.
"inter"
A signed_id from files.upload() for the store logo, or null to remove it.
A signed_id from files.upload() for the logo in transactional emails, or null to remove it.
Response
store updated
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MTL, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMM, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMK, ZMW, ZWD, ZWG, ZWL, ZWN, ZWR aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, de-AT, de-CH, dv, dz, ee, el, en, en-AU, en-CA, en-GB, en-IN, en-NZ, en-US, eo, es, es-419, es-CL, es-EC, es-MX, et, eu, fa, ff, fi, fj, fo, fr, fr-CA, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, pt-BR, pt-PT, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sl-SI, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh-CN, zh-HK, zh-TW, zu Order routing strategy. Built-in: rules. Extensions may register more.
Payout provider; null uses the installation default. Built-in: system. Provider gems register more (e.g. stripe).
g, kg, lb, oz metric, imperial public, prices_hidden, login_required checkout, on_dispatch, manual fallback, strict fallback, strict daily, weekly, biweekly, monthly, manual sequential, random inter, system, helvetica, georgia, roboto, lato, merriweather AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MTL, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMM, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMK, ZMW, ZWD, ZWG, ZWL, ZWN, ZWR aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, de-AT, de-CH, dv, dz, ee, el, en, en-AU, en-CA, en-GB, en-IN, en-NZ, en-US, eo, es, es-419, es-CL, es-EC, es-MX, et, eu, fa, ff, fi, fj, fo, fr, fr-CA, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, pt-BR, pt-PT, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sl-SI, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh-CN, zh-HK, zh-TW, zu aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, de-AT, de-CH, dv, dz, ee, el, en, en-AU, en-CA, en-GB, en-IN, en-NZ, en-US, eo, es, es-419, es-CL, es-EC, es-MX, et, eu, fa, ff, fi, fj, fo, fr, fr-CA, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, pt-BR, pt-PT, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sl-SI, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh-CN, zh-HK, zh-TW, zu