Business Stores

Create a business store

Creates a local provider store. Platform stores (shopify, woocommerce, ...) carry credentials provisioned by their integration install flows and cannot be created through this API.

post/api/v1/business_stores

Request

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

Request body

namestring required
currencystring required

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

uidstring

Unique store identifier; must be unique within the business

urlstring
providerstring

Only "local" is accepted; defaults to "local"

business_idstring

business ID to create the store under (optional for app tokens; defaults to the token's business)

Response

Created 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.