Update Store

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

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

Show child attributes

data.id

string<uuid>

required

The unique identifier of the entity

data.dateCreated

string<date-time>

required

The date the entity was created in the database

data.name

string

required

The name of the store

Required string length: 3 - 64

data.description

string

required

The description of the store, shown on their about page and on the home of their store page

Maximum string length: 4096

data.url

string

required

The subdomain for the store, ONLY the subdomain, not the fully qualified domain

Required string length: 3 - 64

Example:

"\n store\n "

data.urlHistory

string[]

required

The history of URLs this store has had

data.domain

string

required

The domain this store is running on, defaults to mykomerza.com

Required string length: 1 - 72

data.lastCustomDomainUpdate

string<date-time>

required

The last time the custom domain for this store was updated

data.products

object[]

required

The list of products sold by the store

Show child attributes

data.products.id

string<uuid>

required

The unique identifier of the entity

data.products.dateCreated

string<date-time>

required

The date the entity was created in the database

data.products.variants

object[]

required

Collection of product variants linked to the product, allowing multiple versions or options for the product.

Show child attributes

data.products.variants.id

string<uuid>

required

The unique identifier of the entity

data.products.variants.dateCreated

string<date-time>

required

The date the entity was created in the database

data.products.variants.name

string

required

The name of the variant.

Required string length: 3 - 128

data.products.variants.productId

string<uuid>

required

Represents the unique identifier of the product associated with the variant.

data.products.variants.storeId

string<uuid>

required

The unique identifier for the store associated with the variant.

data.products.variants.cost

number<double>

required

The cost of the variant.

Required range: 0 <= x <= 100000

data.products.variants.deliveryTypes

string[]

required

A list of delivery methods associated with the variant.

data.products.variants.files

object[]

required

A collection of stored files associated with this variant.

Show child attributes

data.products.variants.files.id

string<uuid>

required

The unique identifier of the entity

data.products.variants.files.dateCreated

string<date-time>

required

The date the entity was created in the database

data.products.variants.files.friendlyName

string

required

The friendly name of the file

Required string length: 1 - 128

data.products.variants.files.ipAddress

string

required

The IP address which uploaded the file

Required string length: 1 - 45

data.products.variants.files.userId

string

required

The ID of the user who uploaded the file

Required string length: 1 - 36

data.products.variants.minimumQuantity

integer<int32>

required

The minimum quantity of the product variant required for a single order.

data.products.variants.maximumQuantity

integer<int32>

required

The maximum quantity of the variant that can be purchased in a single order. A value of -1 indicates no limit.

data.products.variants.order

integer<int32>

required

Indicates the display order of the variant in a sequence.

data.products.variants.imageNames

string[]

required

A list of image file names associated with the variant.

data.products.variants.stock

integer<int32>

required

Represents the quantity of items available for sale.

data.products.variants.stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

data.products.variants.customFields

object[]

required

Represents the collection of custom fields associated with the variant. Each custom field provides additional configuration or metadata related to the variant, such as labels, identifiers, or placeholders.

Show child attributes

data.products.variants.customFields.id

string<uuid>

required

The unique identifier of the entity

data.products.variants.customFields.dateCreated

string<date-time>

required

The date the entity was created in the database

data.products.variants.customFields.variantId

string<uuid>

required

FK back to the parent Variant.

data.products.variants.customFields.label

string

required

The display label for this custom field.

Required string length: 1 - 128

data.products.variants.customFields.identifier

string

required

A machine-friendly identifier used in forms and storage.

Required string length: 1 - 64

data.products.variants.customFields.type

string

required

The type of the field: "text", "textarea", "select", "checkbox", "radio", or "number".

Required string length: 1 - 256

data.products.variants.customFields.isRequired

boolean

required

Whether filling out this field is mandatory.

data.products.variants.customFields.options

object[]

required

The list of allowed options (only for select or radio fields).

Show child attributes

data.products.variants.customFields.options.id

string<uuid>

required

The unique identifier of the entity

data.products.variants.customFields.options.dateCreated

string<date-time>

required

The date the entity was created in the database

data.products.variants.customFields.options.customFieldId

string<uuid>

required

FK back to the parent CustomField.

data.products.variants.customFields.options.label

string

required

The user-facing label for this option.

Maximum string length: 128

data.products.variants.customFields.options.value

string

required

The stored value for this option (often same as Label).

Maximum string length: 64

data.products.variants.customFields.options.order

integer<int32>

required

Sort order among siblings.

Required range: 0 <= x <= 2147483647

data.products.variants.customFields.placeholder

string | null

Placeholder text shown when the field is empty (for text/textarea).

Maximum string length: 256

data.products.variants.customFields.hint

string | null

Help text displayed under the field.

Maximum string length: 512

data.products.variants.dynamicUrl

string | null

Represents a dynamically generated or configurable URL associated with a variant.

Maximum string length: 2048

data.products.variants.deliveryMessage

string | null

An optional message associated with the delivery of this variant.

Maximum string length: 4096

data.products.variants.metadata

string | null

Miscellaneous metadata associated with the variant, this is used in migration to tie reviews/products

Maximum string length: 1000

data.products.name

string

required

The name of the product. This field is required and must be between 3 and 128 characters in length.

Required string length: 3 - 128

data.products.description

string

required

A detailed description of the product, used to provide additional information or context about the product.

Required string length: 1 - 16384

data.products.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.products.imageNames

string[]

required

Represents a list of image file names associated with the product. This collection is used to manage the images linked to the product and can be manipulated to reorder or delete images.

data.products.storeId

string<uuid>

required

The identifier of the store to which the product belongs.

data.products.userId

string

required

Represents the identifier of the user associated with the product.

Required string length: 1 - 36

data.products.shouldBlockVpns

boolean

required

Determines whether VPN usage should be restricted for this product. If set to true, VPN-based access may be blocked to mitigate potential fraud or compliance issues.

data.products.order

integer<int32>

required

Indicates the display order of the product within its associated store. By default, products are assigned an order value of 1. This property is primarily used to allow custom sorting of products, enabling businesses to prioritize or organize products as needed.

data.products.isBestSeller

boolean

required

Indicates whether the product is marked as a bestseller.

data.products.blacklistedPaymentGateways

string[]

required

The list of payment gateways that are blacklisted and should not be used for processing payments for this product.

data.products.additionalFees

object

required

A collection of additional fees associated with specific payment methods for the product. The key represents the payment method, and the value represents the fee percentage as a string.

Show child attributes

data.products.additionalFees.{key}

string

data.products.slug

string | null

A unique identifier for the product, used to generate user-friendly URLs.

Required string length: 1 - 72

data.products.metadata

string | null

Custom metadata set by either the user or the system to store additional information about the product

Maximum string length: 10000

data.categories

object[]

required

The list of categories for organizing products in the store

Show child attributes

data.categories.id

string<uuid>

required

The unique identifier of the entity

data.categories.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.name

string

required

The name of this category

Required string length: 3 - 128

data.categories.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.categories.order

integer<int32>

required

The ordering index of this category

data.categories.storeId

string<uuid>

required

The store ID that this category belongs to

data.categories.products

object[]

required

The list of products that belong to this category

Show child attributes

data.categories.products.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.categoryId

string<uuid>

required

The ID of the category that the product belongs to

data.categories.products.category

any

required

data.categories.products.productId

string<uuid>

required

The ID of the product that belongs to the category

data.categories.products.product

object

required

Represents a product that belongs to a specific store and contains details such as name, description, visibility, and associated information.

Show child attributes

data.categories.products.product.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.product.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.product.variants

object[]

required

Collection of product variants linked to the product, allowing multiple versions or options for the product.

Show child attributes

data.categories.products.product.variants.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.product.variants.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.product.variants.name

string

required

The name of the variant.

Required string length: 3 - 128

data.categories.products.product.variants.productId

string<uuid>

required

Represents the unique identifier of the product associated with the variant.

data.categories.products.product.variants.storeId

string<uuid>

required

The unique identifier for the store associated with the variant.

data.categories.products.product.variants.cost

number<double>

required

The cost of the variant.

Required range: 0 <= x <= 100000

data.categories.products.product.variants.deliveryTypes

string[]

required

A list of delivery methods associated with the variant.

data.categories.products.product.variants.files

object[]

required

A collection of stored files associated with this variant.

Show child attributes

data.categories.products.product.variants.files.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.product.variants.files.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.product.variants.files.friendlyName

string

required

The friendly name of the file

Required string length: 1 - 128

data.categories.products.product.variants.files.ipAddress

string

required

The IP address which uploaded the file

Required string length: 1 - 45

data.categories.products.product.variants.files.userId

string

required

The ID of the user who uploaded the file

Required string length: 1 - 36

data.categories.products.product.variants.minimumQuantity

integer<int32>

required

The minimum quantity of the product variant required for a single order.

data.categories.products.product.variants.maximumQuantity

integer<int32>

required

The maximum quantity of the variant that can be purchased in a single order. A value of -1 indicates no limit.

data.categories.products.product.variants.order

integer<int32>

required

Indicates the display order of the variant in a sequence.

data.categories.products.product.variants.imageNames

string[]

required

A list of image file names associated with the variant.

data.categories.products.product.variants.stock

integer<int32>

required

Represents the quantity of items available for sale.

data.categories.products.product.variants.stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

data.categories.products.product.variants.customFields

object[]

required

Show child attributes

data.categories.products.product.variants.customFields.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.product.variants.customFields.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.product.variants.customFields.variantId

string<uuid>

required

FK back to the parent Variant.

data.categories.products.product.variants.customFields.label

string

required

The display label for this custom field.

Required string length: 1 - 128

data.categories.products.product.variants.customFields.identifier

string

required

A machine-friendly identifier used in forms and storage.

Required string length: 1 - 64

data.categories.products.product.variants.customFields.type

string

required

The type of the field: "text", "textarea", "select", "checkbox", "radio", or "number".

Required string length: 1 - 256

data.categories.products.product.variants.customFields.isRequired

boolean

required

Whether filling out this field is mandatory.

data.categories.products.product.variants.customFields.options

object[]

required

The list of allowed options (only for select or radio fields).

Show child attributes

data.categories.products.product.variants.customFields.options.id

string<uuid>

required

The unique identifier of the entity

data.categories.products.product.variants.customFields.options.dateCreated

string<date-time>

required

The date the entity was created in the database

data.categories.products.product.variants.customFields.options.customFieldId

string<uuid>

required

FK back to the parent CustomField.

data.categories.products.product.variants.customFields.options.label

string

required

The user-facing label for this option.

Maximum string length: 128

data.categories.products.product.variants.customFields.options.value

string

required

The stored value for this option (often same as Label).

Maximum string length: 64

data.categories.products.product.variants.customFields.options.order

integer<int32>

required

Sort order among siblings.

Required range: 0 <= x <= 2147483647

data.categories.products.product.variants.customFields.placeholder

string | null

Placeholder text shown when the field is empty (for text/textarea).

Maximum string length: 256

data.categories.products.product.variants.customFields.hint

string | null

Help text displayed under the field.

Maximum string length: 512

data.categories.products.product.variants.dynamicUrl

string | null

Represents a dynamically generated or configurable URL associated with a variant.

Maximum string length: 2048

data.categories.products.product.variants.deliveryMessage

string | null

An optional message associated with the delivery of this variant.

Maximum string length: 4096

data.categories.products.product.variants.metadata

string | null

Miscellaneous metadata associated with the variant, this is used in migration to tie reviews/products

Maximum string length: 1000

data.categories.products.product.name

string

required

The name of the product. This field is required and must be between 3 and 128 characters in length.

Required string length: 3 - 128

data.categories.products.product.description

string

required

A detailed description of the product, used to provide additional information or context about the product.

Required string length: 1 - 16384

data.categories.products.product.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.categories.products.product.imageNames

string[]

required

Represents a list of image file names associated with the product. This collection is used to manage the images linked to the product and can be manipulated to reorder or delete images.

data.categories.products.product.storeId

string<uuid>

required

The identifier of the store to which the product belongs.

data.categories.products.product.userId

string

required

Represents the identifier of the user associated with the product.

Required string length: 1 - 36

data.categories.products.product.shouldBlockVpns

boolean

required

Determines whether VPN usage should be restricted for this product. If set to true, VPN-based access may be blocked to mitigate potential fraud or compliance issues.

data.categories.products.product.order

integer<int32>

required

data.categories.products.product.isBestSeller

boolean

required

Indicates whether the product is marked as a bestseller.

data.categories.products.product.blacklistedPaymentGateways

string[]

required

The list of payment gateways that are blacklisted and should not be used for processing payments for this product.

data.categories.products.product.additionalFees

object

required

A collection of additional fees associated with specific payment methods for the product. The key represents the payment method, and the value represents the fee percentage as a string.

Show child attributes

data.categories.products.product.additionalFees.{key}

string

data.categories.products.product.slug

string | null

A unique identifier for the product, used to generate user-friendly URLs.

Required string length: 1 - 72

data.categories.products.product.metadata

string | null

Custom metadata set by either the user or the system to store additional information about the product

Maximum string length: 10000

data.categories.products.order

integer<int32>

required

The order index of the product within the category

data.categories.slug

string | null

The slug of this category

Required string length: 1 - 72

data.userId

string

required

The ID of the user who owns the store

Required string length: 1 - 36

data.coupons

object[]

required

The list of coupon codes that can be used on the store

Show child attributes

data.coupons.id

string<uuid>

required

The unique identifier of the entity

data.coupons.dateCreated

string<date-time>

required

The date the entity was created in the database

data.coupons.code

string

required

The case-insensitive code the customer will enter to redeem the coupon (this should be lowercased)

Required string length: 3 - 32

data.coupons.uses

integer<int32>

required

The amount of times the coupon code has been used

data.coupons.maximumUses

integer<int32>

required

The maximum amount of usages the coupon code has, -1 = infinite

Required range: 0 <= x <= 100000000

data.coupons.isEnabled

boolean

required

Whether the coupon code is enabled and can be used in checkout

data.coupons.storeId

string<uuid>

required

The ID of the store the coupon belongs to

data.coupons.percentageDecrease

number<double> | null

The percentage that should be subtracted from the total order cost when used

Required range: 0 <= x <= 100

data.coupons.amountDecrease

number<double> | null

The static amount to be subtracted from the total order cost when used

Required range: 0 <= x <= 100000

data.coupons.variantIds

string<uuid>[] | null

The list of variant IDs that the coupon is enabled for, null if it is global

data.coupons.expirationDate

string<date-time> | null

The date and time when the coupon will expire and can no longer be used

data.webhookSecret

string

required

The webhook signing secret used to verify webhook payloads

Maximum string length: 128

data.currencyCode

string

required

The preferred fiat currency to display for the store, defaults to USD

Maximum string length: 4

data.prependProductNameToReceipt

boolean

required

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

data.isAutomaticReviewsEnabled

boolean

required

Whether automatic review leaving is enabled

data.isCustomerBalanceEnabled

boolean

required

Whether the customer balance system is enabled on the stores

data.isInactive

boolean

required

Whether the system has detected that the store is inactive

data.builderRepository

object

Represents a repository that stores metadata and configuration data related to the frontend architecture and build processes for a specific store. Provides references to associated worker identities, user ownership, and messaging or snapshot relationships.

Show child attributes

data.builderRepository.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.messages

object[]

required

A collection of messages associated with the builder repository.

Show child attributes

data.builderRepository.messages.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.messages.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.messages.repositoryId

string<uuid>

required

Represents the unique identifier of the parent repository that this message is associated with.

data.builderRepository.messages.role

string

required

Specifies the role associated with the message, typically indicating the sender's role, such as user or system.

Required string length: 1 - 64

data.builderRepository.messages.completionTokens

integer<int64>

required

Represents the number of tokens generated by the AI in the response during message completion processing.

data.builderRepository.messages.promptTokens

integer<int64>

required

Represents the number of tokens used in the input prompt for a message.

data.builderRepository.messages.totalTokens

integer<int64>

required

Represents the total number of tokens associated with a message or group of messages, often used to track resource usage or capacity in the context of processing textual content.

data.builderRepository.messages.externalId

string | null

Represents an optional unique identifier for external systems or integrations.

Maximum string length: 256

data.builderRepository.messages.annotations

string | null

A JSON-encoded string representation of additional metadata or usage annotations associated with the message. This may include context-specific data or processing directives.

Maximum string length: 32000

data.builderRepository.messages.content

string | null

Represents the text content of a message sent from the builder client. May contain extended information or data relevant to the message. Maximum length is 512,000 characters.

Maximum string length: 512000

data.builderRepository.messages.revisionId

string | null

Identifies the version or revision of the message content.

Maximum string length: 256

data.builderRepository.messages.ipAddress

string | null

Represents the IP address associated with the builder message source.

Maximum string length: 128

data.builderRepository.websites

object[]

required

The list of websites associated with the user, max 10

Show child attributes

data.builderRepository.websites.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.websites.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.websites.repositoryId

string<uuid>

required

The ID of the repository the website belongs to

data.builderRepository.websites.fileData

string<byte>

required

The GZip compressed file data of the website

data.builderRepository.websites.fileDataHash

string

required

The hash of the file data, used to prevent duplicate websites from being added to the repository

Maximum string length: 128

data.builderRepository.websites.compressedSize

integer<int64>

required

The size of the website in bytes when compressed

data.builderRepository.websites.size

integer<int64>

required

The size of the website in bytes when not compressed

data.builderRepository.userId

string

required

The unique identifier associated with the user who owns or is related to this repository.

Required string length: 1 - 36

data.builderRepository.storeId

string<uuid>

required

Unique identifier of the store associated with the builder repository.

data.builderRepository.monthlyTokens

integer<int64>

required

Represents the total number of PLATFORM tokens used for a store in the current month.

data.builderRepository.consumedAllTokens

boolean

required

Whether the user has consumed all tokens for the current month.

data.builderRepository.usage

object[]

required

The fine-grained usage of the builder for the store, this is based on each month

Show child attributes

data.builderRepository.usage.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.usage.dateCreated

string<date>

required

Gets or sets the date when the entity was created.

data.builderRepository.usage.platformTotalTokens

integer<int64>

required

Represents the total number of tokens utilized across the platform.

data.builderRepository.usage.totalTokens

integer<int64>

required

Represents the total combined number of tokens used.

data.builderRepository.usage.inputTokens

integer<int64>

required

Represents the number of input tokens consumed by the builder.

data.builderRepository.usage.outputTokens

integer<int64>

required

Represents the total number of tokens generated as output.

data.builderRepository.usage.repositoryId

string<uuid>

required

Represents the unique identifier for the associated repository. Serves as a foreign key linking to the BuilderRepository entity.

data.builderRepository.usage.repository

any

required

data.builderRepository.machines

object[]

required

Show child attributes

data.builderRepository.machines.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.machines.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.machines.isTerminated

boolean

required

Indicates whether the machine has been terminated.

data.builderRepository.machines.source

string

required

The source code or identifier for this preview machine.

Required string length: 1 - 128

data.builderRepository.machines.sourceId

string

required

The identifier of the source for this preview machine.

Required string length: 1 - 128

data.builderRepository.machines.name

string

required

Name of the builder preview machine.

Required string length: 1 - 128

data.builderRepository.machines.privateIpAddress

string

required

IP address of the builder preview machine.

Required string length: 1 - 45

data.builderRepository.machines.events

object[]

required

Collection of events for this machine.

Show child attributes

data.builderRepository.machines.events.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.machines.events.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.machines.events.source

string

required

User code of the source that triggered the builder preview event.

Maximum string length: 128

data.builderRepository.machines.events.type

string

required

Type of event generated by the builder preview.

Maximum string length: 128

data.builderRepository.machines.events.message

string

required

Message associated with the event.

Maximum string length: 5000

data.builderRepository.machines.events.machineId

string<uuid>

required

Unique identifier for the machine that generated this event.

data.builderRepository.machines.storeId

string<uuid>

required

Identifier of the store that owns this preview machine.

data.builderRepository.machines.repositoryId

string<uuid>

required

Repository identifier for the preview machine.

data.builderRepository.machines.userId

string

required

The identifier of the user who owns or operates this machine.

Required string length: 1 - 48

data.builderRepository.urlId

string | null

Represents an optional, URL-friendly identifier used for deep-linking and reference purposes.

Maximum string length: 128

data.builderRepository.externalId

string | null

Optional external identifier that can be used for integrations or mapping with external systems.

Maximum string length: 128

data.builderRepository.description

string | null

A brief description of the repository or its purpose.

Maximum string length: 128

data.builderRepository.currentWebsiteId

string<uuid> | null

The ID of the current website that is active

data.builderRepository.currentWebsite

object

Represents a website entity in the builder module with associated repository.

Show child attributes

data.builderRepository.currentWebsite.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.currentWebsite.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.currentWebsite.repositoryId

string<uuid>

required

The ID of the repository the website belongs to

data.builderRepository.currentWebsite.fileData

string<byte>

required

The GZip compressed file data of the website

data.builderRepository.currentWebsite.fileDataHash

string

required

The hash of the file data, used to prevent duplicate websites from being added to the repository

Maximum string length: 128

data.builderRepository.currentWebsite.compressedSize

integer<int64>

required

The size of the website in bytes when compressed

data.builderRepository.currentWebsite.size

integer<int64>

required

The size of the website in bytes when not compressed

data.builderRepository.snapshot

object

Represents a snapshot of a builder entity within the project's context.

Show child attributes

data.builderRepository.snapshot.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.snapshot.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.snapshot.repositoryId

string<uuid>

required

Represents the unique identifier of the associated repository for the builder snapshot.

data.builderRepository.snapshot.size

integer<int64>

required

The size of the builder snapshot in bytes, calculated based on the cumulative size of its contents.

data.builderRepository.snapshot.chatIndex

string

required

Represents the unique index or identifier for organizing and retrieving chat-related data.

Required string length: 1 - 128

data.builderRepository.snapshot.files

object

required

A collection of files associated with the builder snapshot, represented as a dictionary where the key is the file identifier and the value is the corresponding file data.

Show child attributes

data.builderRepository.snapshot.files.{key}

object

Represents a file that is part of a builder snapshot, containing metadata such as its type, content, and state (locked or binary).

Show child attributes

data.builderRepository.snapshot.files.{key}.id

string<uuid>

required

The unique identifier of the entity

data.builderRepository.snapshot.files.{key}.dateCreated

string<date-time>

required

The date the entity was created in the database

data.builderRepository.snapshot.files.{key}.type

string

required

The type of the file included in the builder snapshot.

Required string length: 1 - 16

data.builderRepository.snapshot.files.{key}.isLocked

boolean

required

Indicates whether the file is locked, preventing modifications.

data.builderRepository.snapshot.files.{key}.isBinary

boolean

required

Indicates whether the file content is binary.

data.builderRepository.snapshot.files.{key}.content

string | null

The content of the file that has been snapshotted. It represents the data of the file as a string and can be used to store text or other forms of serialized file content.

Maximum string length: 512000

data.builderRepository.snapshot.files.{key}.isLockedByFolder

string | null

Indicates if the file is locked specifically by its association with a folder.

Maximum string length: 128

data.builderRepository.snapshot.summary

string | null

A textual overview or description associated with the builder snapshot

Maximum string length: 15000

data.builderRepository.consumedAt

string<date-time> | null

Indicates the date and time when all usage tokens were consumed.

data.customDomain

string | null

The custom domain set for the store, will be null if not set. Use the Cloudflare API to fetch extended data on their custom domain integration

Maximum string length: 128

data.affiliateOptions

object

Represents the options available for affiliates on stores.

Show child attributes

data.affiliateOptions.id

string<uuid>

required

The unique identifier of the entity

data.affiliateOptions.dateCreated

string<date-time>

required

The date the entity was created in the database

data.affiliateOptions.isEnabled

boolean

required

Gets or sets a value indicating whether the affiliate options are enabled for a store.

data.affiliateOptions.defaultReturnPercentage

integer<int32>

required

Gets or sets the default percentage of returns that an affiliate can receive. This percentage is used to calculate the return share for affiliates.

data.affiliateOptions.isPublicRegistrationEnabled

boolean

required

Gets or sets a value indicating whether public registration for affiliates is enabled.

data.affiliateOptions.isLinkEditingEnabled

boolean

required

Whether affiliates can edit their own affiliate link

data.affiliateOptions.canConvertAffiliateBalance

boolean

required

Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when enabled any affiliate can convert their affiliate balance into customer balance automatically

data.affiliateOptions.defaultPercentageOff

integer<int32> | null

Gets or sets the default percentage off value for affiliates.

data.storeBrandOptions

object

Represents the options for configuring the branding within a store.

Show child attributes

data.storeBrandOptions.id

string<uuid>

required

The unique identifier of the entity

data.storeBrandOptions.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeBrandOptions.storeId

string<uuid>

required

Unique identifier for the store associated with the checkout options.

data.storeBrandOptions.isAutomaticCurrencyConversionEnabled

boolean

required

Indicates whether automatic currency conversion is enabled, this is strictly for displaying on the checkout which improves conversion

data.storeBrandOptions.bannerFileName

string | null

Represents the file name of the banner associated with the checkout options.

Maximum string length: 64

data.storeBrandOptions.iconFileName

string | null

The icon file name, used for favicon

Maximum string length: 64

data.storeBrandOptions.accentColor

string | null

Represents the accent color used in the checkout options.

Maximum string length: 9

data.notificationOptions

object

The notification options for a store

Show child attributes

data.notificationOptions.id

string<uuid>

required

The unique identifier of the entity

data.notificationOptions.dateCreated

string<date-time>

required

The date the entity was created in the database

data.notificationOptions.discordWebhookUrl

string | null

The Discord webhook notification URL to send events to

Maximum string length: 512

data.maintenanceReason

string | null

The reason the store is in maintenance, if this is null then the store is not in maintenance mode

Maximum string length: 1024

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Path Parameters

Body

Response