Shops

Change a shop's settings (name, VAT, payments, policies, …)

patch/shops/{shopId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/shops/{shopId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

shopIdstring uuid required

Request body

UpdateShopInputBody required

See UpdateShopInput in packages/platform/src/contracts-shop.ts

Response

The shop

idstring uuid required
keystring required

The public key the site's storefront calls use

projectIdstring uuid required
sessionIdstring uuid nullable required
status'active' | 'closed' required
namestring required
currencystring required
countrystring required
pricesIncludeVatboolean required
vatNumberstring nullable required
orgNumberstring nullable required
ossboolean required
storeEmailstring nullable required
orderPrefixstring required
sellerAddressstring nullable required
languagestring required
lowStockThresholdinteger required
unpaidCancelDaysinteger required
stripeEnabledboolean required
policiesobject required
euDistanceSalesEurCentsinteger required
testPaymentsboolean required

The test gateway is available (test and smoke-test teams only)

storefrontUrlstring required

Base URL of the public storefront API for this shop

createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.