Business Stores

Update a business store

Updates the store's metadata. provider, uid and store_type are immutable after creation.

patch/api/v1/business_stores/{id}

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/business_stores/{id}
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: business_stores:write)

Path parameters

idstring required

business store ID

Request body

namestring
currencystring

Three-letter ISO 4217 code, e.g. USD

urlstring

Response

Updated store

idstring
namestring nullable
currencystring
uidstring nullable

Store identifier on the commerce platform

urlstring nullable
providerstring

e.g. shopify, woocommerce, local

business_idstring
store_typestring

store, creator-store, or b2b-syndication-store

Changes

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