Skip to main content
POST
/
stores
Create a new store
curl --request POST \
  --url https://api.komerza.com/stores \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "prependProductNameToReceipt": true,
  "currencyCode": "<string>",
  "isAutomaticReviewsEnabled": true
}
'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "url": "\n                store\n            ",
    "currencyCode": "<string>",
    "prependProductNameToReceipt": true,
    "isAutomaticReviewsEnabled": true,
    "rating": 123,
    "domain": "<string>",
    "isCustomerBalanceEnabled": true,
    "branding": {
      "isAutomaticCurrencyConversionEnabled": true,
      "bannerFileName": "<string>",
      "iconFileName": "<string>",
      "accentColor": "<string>"
    },
    "customDomain": "<string>",
    "scopes": [
      "<string>"
    ],
    "maintenanceReason": "<string>",
    "affiliateOptions": {
      "isEnabled": true,
      "defaultReturnPercentage": 50,
      "canConvertAffiliateBalance": true,
      "isPublicRegistrationEnabled": true,
      "isLinkEditingEnabled": true,
      "defaultPercentageOff": 50
    }
  }
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Body

application/json

The form containing the details of the new store.

Form for updating or creating a store. This version is returned for authenticated API endpoints, any public endpoint will use a PublicStore or PublicStoreReference

​
url
string
required

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

Required string length: 3 - 32
​
name
string
required

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

Required string length: 3 - 32
​
description
string
required

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

Maximum string length: 4096
​
prependProductNameToReceipt
boolean
required

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

​
currencyCode
string
required

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

​
isAutomaticReviewsEnabled
boolean
required

Whether automatic review leaving is enabled

Response

The object was successfully created.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

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

​
code
string | null

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

​
data
object

A reference to a store which is owned by a merchant that can be used as a front for selling products to customers