Skip to main content
PUT
/
stores
/
{storeId}
Update a store
curl --request PUT \
  --url https://api.komerza.com/stores/{storeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "prependProductNameToReceipt": true,
  "currencyCode": "<string>",
  "isAutomaticReviewsEnabled": true,
  "isTicketingEnabled": true,
  "showPublicStats": true,
  "showRecentOrderToasts": true,
  "enableCartRecovery": true,
  "termsOfServiceUrl": "<string>",
  "refundPolicyUrl": "<string>",
  "privacyPolicyUrl": "<string>",
  "externalSupportUrl": "<string>",
  "externalSupportDescription": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "builderProjects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "backups": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "fileDataHash": "<string>",
            "compressedSize": 123,
            "size": 123,
            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "userId": "<string>",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storageKey": "<string>",
            "name": "<string>"
          }
        ],
        "machines": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "isTerminated": true,
            "source": "<string>",
            "sourceId": "<string>",
            "name": "<string>",
            "privateIpAddress": "<string>",
            "events": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "source": "<string>",
                "type": "<string>",
                "message": "<string>",
                "machineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ],
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "userId": "<string>"
          }
        ],
        "pages": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "project": "<unknown>",
            "path": "<string>",
            "title": "<string>",
            "description": "<string>",
            "ogImage": "<string>"
          }
        ],
        "environmentVariables": {},
        "urlId": "<string>",
        "name": "<string>",
        "currentWebsiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currentWebsite": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "fileDataHash": "<string>",
          "compressedSize": 123,
          "size": 123,
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "userId": "<string>",
          "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "storageKey": "<string>",
          "sourceTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sourceCommitHash": "<string>",
          "sourceReleaseTag": "<string>"
        },
        "globalSeo": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "project": "<unknown>",
          "title": "<string>",
          "description": "<string>",
          "ogImage": "<string>"
        }
      }
    ],
    "name": "<string>",
    "description": "<string>",
    "url": "\n                store\n            ",
    "urlHistory": [
      "<string>"
    ],
    "domain": "<string>",
    "lastCustomDomainUpdate": "2023-11-07T05:31:56Z",
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "variants": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cost": 50000,
            "deliveryTypes": [
              "<string>"
            ],
            "files": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "friendlyName": "<string>",
                "ipAddress": "<string>",
                "userId": "<string>"
              }
            ],
            "minimumQuantity": 123,
            "maximumQuantity": 123,
            "order": 123,
            "imageNames": [
              "<string>"
            ],
            "stock": 123,
            "customFields": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "label": "<string>",
                "identifier": "<string>",
                "type": "<string>",
                "isRequired": true,
                "options": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "dateCreated": "2023-11-07T05:31:56Z",
                    "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "label": "<string>",
                    "value": "<string>",
                    "order": 1073741823
                  }
                ],
                "placeholder": "<string>",
                "hint": "<string>"
              }
            ],
            "volumeDiscounts": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "quantity": 1073741824,
                "discountValue": 50000
              }
            ],
            "disableVolumeDiscountOnCoupon": true,
            "dynamicUrl": "<string>",
            "deliveryMessage": "<string>",
            "metadata": "<string>",
            "customIntervalDays": 123
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "imageNames": [
          "<string>"
        ],
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "<string>",
        "shouldBlockVpns": true,
        "order": 123,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "<string>"
        ],
        "additionalFees": {},
        "additionalFixedFees": {},
        "slug": "<string>",
        "metaDescription": "<string>",
        "metadata": "<string>",
        "customAffiliateDiscountPercentage": 50,
        "subscriptionAllowPause": true,
        "subscriptionMaxPauseDurationDays": 123,
        "subscriptionMaxPauseCount": 123,
        "subscriptionAllowCancel": true,
        "subscriptionAllowReactivate": true,
        "subscriptionGracePeriodDays": 123,
        "subscriptionRevokeOnExpiry": true
      }
    ],
    "categories": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "order": 123,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "products": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "category": "<unknown>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "product": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dateCreated": "2023-11-07T05:31:56Z",
              "variants": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "dateCreated": "2023-11-07T05:31:56Z",
                  "name": "<string>",
                  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "cost": 50000,
                  "deliveryTypes": [
                    "<string>"
                  ],
                  "files": [
                    {
                      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                      "dateCreated": "2023-11-07T05:31:56Z",
                      "friendlyName": "<string>",
                      "ipAddress": "<string>",
                      "userId": "<string>"
                    }
                  ],
                  "minimumQuantity": 123,
                  "maximumQuantity": 123,
                  "order": 123,
                  "imageNames": [
                    "<string>"
                  ],
                  "stock": 123,
                  "customFields": [
                    {
                      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                      "dateCreated": "2023-11-07T05:31:56Z",
                      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                      "label": "<string>",
                      "identifier": "<string>",
                      "type": "<string>",
                      "isRequired": true,
                      "options": [
                        {
                          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                          "dateCreated": "2023-11-07T05:31:56Z",
                          "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                          "label": "<string>",
                          "value": "<string>",
                          "order": 1073741823
                        }
                      ],
                      "placeholder": "<string>",
                      "hint": "<string>"
                    }
                  ],
                  "volumeDiscounts": [
                    {
                      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                      "dateCreated": "2023-11-07T05:31:56Z",
                      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                      "quantity": 1073741824,
                      "discountValue": 50000
                    }
                  ],
                  "disableVolumeDiscountOnCoupon": true,
                  "dynamicUrl": "<string>",
                  "deliveryMessage": "<string>",
                  "metadata": "<string>",
                  "customIntervalDays": 123
                }
              ],
              "name": "<string>",
              "description": "<string>",
              "imageNames": [
                "<string>"
              ],
              "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "userId": "<string>",
              "shouldBlockVpns": true,
              "order": 123,
              "isBestSeller": true,
              "blacklistedPaymentGateways": [
                "<string>"
              ],
              "additionalFees": {},
              "additionalFixedFees": {},
              "slug": "<string>",
              "metaDescription": "<string>",
              "metadata": "<string>",
              "customAffiliateDiscountPercentage": 50,
              "subscriptionAllowPause": true,
              "subscriptionMaxPauseDurationDays": 123,
              "subscriptionMaxPauseCount": 123,
              "subscriptionAllowCancel": true,
              "subscriptionAllowReactivate": true,
              "subscriptionGracePeriodDays": 123,
              "subscriptionRevokeOnExpiry": true
            },
            "order": 123
          }
        ],
        "slug": "<string>",
        "metaDescription": "<string>",
        "imageName": "<string>"
      }
    ],
    "blogPosts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "content": "<string>",
        "isFeatured": true,
        "tags": [
          "<string>"
        ],
        "order": 123,
        "readTimeMinutes": 123,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "authorId": "<string>",
        "categories": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "blogPostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "post": "<unknown>",
            "blogCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "category": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dateCreated": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "order": 123,
              "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "posts": "<array>",
              "slug": "<string>",
              "description": "<string>"
            },
            "order": 123
          }
        ],
        "slug": "<string>",
        "excerpt": "<string>",
        "metaDescription": "<string>",
        "coverImageName": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "blogCategories": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "order": 123,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "posts": "<array>",
        "slug": "<string>",
        "description": "<string>"
      }
    ],
    "userId": "<string>",
    "coupons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "code": "<string>",
        "uses": 123,
        "maximumUses": 49999999,
        "isEnabled": true,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "percentageDecrease": 50,
        "amountDecrease": 50000,
        "variantIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "expirationDate": "2023-11-07T05:31:56Z"
      }
    ],
    "blacklists": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "data": "<string>",
        "isEnabled": true,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "note": "<string>"
      }
    ],
    "webhookSecret": "<string>",
    "currencyCode": "<string>",
    "prependProductNameToReceipt": true,
    "isAutomaticReviewsEnabled": true,
    "isCustomerBalanceEnabled": true,
    "isTicketingEnabled": true,
    "autoBlockOnChargeback": true,
    "blockVpnProxy": true,
    "kickFromDiscordOnBlock": true,
    "isInactive": true,
    "showPublicStats": true,
    "showRecentOrderToasts": true,
    "enableCartRecovery": true,
    "customDomain": "<string>",
    "affiliateOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "isEnabled": true,
      "defaultReturnPercentage": 123,
      "isPublicRegistrationEnabled": true,
      "isLinkEditingEnabled": true,
      "canConvertAffiliateBalance": true,
      "defaultPercentageOff": 123
    },
    "storeBrandOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isAutomaticCurrencyConversionEnabled": true,
      "bannerFileName": "<string>",
      "iconFileName": "<string>",
      "accentColor": "<string>"
    },
    "notificationOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "disabledEmailNotifications": [
        "<string>"
      ],
      "disabledDiscordNotifications": [
        "<string>"
      ],
      "discordWebhookUrl": "<string>"
    },
    "businessInformation": {
      "countryCode": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "legalEntityType": "<string>",
      "taxId": "<string>",
      "fullName": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>"
    },
    "taxOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "isEnabled": true,
      "taxBehavior": "<string>",
      "defaultTaxRate": 123,
      "defaultTaxName": "<string>",
      "businessCountryCode": "<string>",
      "vatId": "<string>"
    },
    "subscriptionOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "allowPause": true,
      "allowCancel": true,
      "allowReactivate": true,
      "allowPaymentMethodUpdate": true,
      "gracePeriodDays": 123,
      "maxRetryAttempts": 123,
      "reminderSchedule": "<string>",
      "sendExpiryNotifications": true,
      "revokeOnExpiry": true,
      "forceManualRenewal": true,
      "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "maxPauseDurationDays": 123,
      "maxPauseCount": 123
    },
    "maintenanceReason": "<string>",
    "termsOfServiceUrl": "<string>",
    "refundPolicyUrl": "<string>",
    "privacyPolicyUrl": "<string>",
    "externalSupportUrl": "<string>",
    "externalSupportDescription": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

The ID of the store to update.

Body

application/json

The form containing the new data to update the store with.

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

​
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

​
isTicketingEnabled
boolean
required

Whether the built-in support ticket system is enabled for customers. When disabled, customers are directed to the external support URL instead.

​
showPublicStats
boolean
required

Whether anonymized public statistics are shown to buyers on the storefront. Disabled by default for privacy.

​
showRecentOrderToasts
boolean
required

Whether recent order toast notifications are shown to visitors on the storefront. Disabled by default for privacy.

​
enableCartRecovery
boolean
required

Whether abandoned cart recovery emails are enabled for this store. Requires email marketing credits. Disabled by default.

​
termsOfServiceUrl
string<uri> | null

The URL to the store's terms of service page

Maximum string length: 512
​
refundPolicyUrl
string<uri> | null

The URL to the store's refund policy page

Maximum string length: 512
​
privacyPolicyUrl
string<uri> | null

The URL to the store's privacy policy page

Maximum string length: 512
​
externalSupportUrl
string<uri> | null

The URL to direct customers to for external support when ticketing is disabled. Required when ticketing is disabled.

Maximum string length: 512
​
externalSupportDescription
string | null

A description shown to customers explaining where to get support when ticketing is disabled.

Maximum string length: 1024

Response

The object was successfully updated.

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

Represents a storefront that contains products that will be sold under it's name