Store

Create a new store

Creates a new store for the current user. Requires the stores.create permission.

post/stores

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/stores/post.ts
A function with typed inputs. Its response is checked against the schema.

urlstring required

The subdomain part of the store URL, just one word and will qualify to x.komerza.com

namestring required

The name of the store as shown on the users store page

descriptionstring required

The store description, shown on the store home page underneath the title

prependProductNameToReceiptboolean required

Whether the name of the product should be prepended to the start of delivery receipts to customers

currencyCodestring required

The ISO-compliant fiat currency code that is preferred for the store, defaults to USD

isAutomaticReviewsEnabledboolean required

Whether automatic review leaving is enabled

The object was successfully created.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

{
  "data": {
    "url": "\n                store\n            "
  }
}

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