API Documentation
User
Products
Categories
Variants
- GETGet Variant
- GETGet License Keys
- POSTCreate Variant
- POSTCreate Field
- POSTCreate Field Option
- PUTAdd License Keys
- PUTUpdate Variant
- PUTUpdate Delivery Settings
- PUTUpdate Field
- PUTUpdate Field Option
- PATCHOrder Variant Images
- DELDelete License Keys
- DELClear License Keys
- DELDelete Variant
- DELDelete Field
- DELDelete Field Option
Coupons
Customers
curl --request POST \
--url https://api.komerza.com/stores/{storeId}/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variants": [
{
"name": "<string>",
"cost": 50000,
"minimumQuantity": 1073741824,
"maximumQuantity": 1073741823,
"order": 1073741824,
"type": 0,
"stock": 1073741823,
"deliveryTypes": [
"<string>"
],
"stockMode": 0,
"dynamicUrl": "<string>",
"deliveryMessage": "<string>",
"subscriptionPeriod": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"isBestSeller": true,
"slug": "<string>"
}
'{
"success": true,
"message": "<string>",
"code": "<string>",
"data": {
"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,
"stockMode": 0,
"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>"
}
],
"dynamicUrl": "<string>",
"deliveryMessage": "<string>",
"metadata": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"visibility": 0,
"imageNames": [
"<string>"
],
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"shouldBlockVpns": true,
"order": 123,
"isBestSeller": true,
"blacklistedPaymentGateways": [
"<string>"
],
"additionalFees": {},
"slug": "<string>",
"metadata": "<string>"
}
}Create Product
Creates a new product in the store.
Requires the stores.products.create permission.
curl --request POST \
--url https://api.komerza.com/stores/{storeId}/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variants": [
{
"name": "<string>",
"cost": 50000,
"minimumQuantity": 1073741824,
"maximumQuantity": 1073741823,
"order": 1073741824,
"type": 0,
"stock": 1073741823,
"deliveryTypes": [
"<string>"
],
"stockMode": 0,
"dynamicUrl": "<string>",
"deliveryMessage": "<string>",
"subscriptionPeriod": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"isBestSeller": true,
"slug": "<string>"
}
'{
"success": true,
"message": "<string>",
"code": "<string>",
"data": {
"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,
"stockMode": 0,
"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>"
}
],
"dynamicUrl": "<string>",
"deliveryMessage": "<string>",
"metadata": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"visibility": 0,
"imageNames": [
"<string>"
],
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "<string>",
"shouldBlockVpns": true,
"order": 123,
"isBestSeller": true,
"blacklistedPaymentGateways": [
"<string>"
],
"additionalFees": {},
"slug": "<string>",
"metadata": "<string>"
}
}Authorizations
Your API key goes here
Path Parameters
The ID of the store.
Body
The Komerza.Common.Forms.Products.CreateProductForm with product details.
Form for creating a product in a store
The list of variants to create in the product
Show child attributes
Show child attributes
The display name of the variant.
3 - 128The cost of the variant (non-negative).
0 <= x <= 100000Minimum quantity allowed per order (at least 1).
1 <= x <= 2147483647Maximum quantity allowed per order. Set to -1 for unlimited.
-1 <= x <= 2147483647Sort order for display (at least 1).
1 <= x <= 2147483647The type of product that is being sold
0, 1 Stock quantity available (non-negative).
0 <= x <= 2147483647Enabled delivery types. Valid values: license_keys, dynamic, keyauth, instructions, files.
The stock calculation modes that are used
0, 1, 2 URL for dynamic fulfillment (when using the "dynamic" delivery type).
2048Optional message shown on delivery.
4096Subscription billing period. Null for one-time products.
The name of the product, this is displayed publicly on the store page and marketplace
3 - 64The description of the product, supports markdown and images from IMGBB only
16384Whether the product should be marked as the bestseller on the user's store page, does nothing for the marketplace
The slug of the product, if null then the ID is used
1 - 72Response
The object was successfully created.
Represents a default generic response for API endpoints.
Indicates whether the operation or response was successful.
A descriptive message providing additional context or information about the response.
The error code (if there was an error) to use when referencing the error
Represents a product that belongs to a specific store and contains details such as name, description, visibility, and associated information.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
Collection of product variants linked to the product, allowing multiple versions or options for the product.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The name of the variant.
3 - 128Represents the unique identifier of the product associated with the variant.
The unique identifier for the store associated with the variant.
The cost of the variant.
0 <= x <= 100000A list of delivery methods associated with the variant.
A collection of stored files associated with this variant.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The friendly name of the file
1 - 128The IP address which uploaded the file
1 - 45The ID of the user who uploaded the file
1 - 36The minimum quantity of the product variant required for a single order.
The maximum quantity of the variant that can be purchased in a single order. A value of -1 indicates no limit.
Indicates the display order of the variant in a sequence.
A list of image file names associated with the variant.
Represents the quantity of items available for sale.
The stock calculation modes that are used
0, 1, 2 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
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
FK back to the parent Variant.
The display label for this custom field.
1 - 128A machine-friendly identifier used in forms and storage.
1 - 64The type of the field: "text", "textarea", "select", "checkbox", "radio", or "number".
1 - 256Whether filling out this field is mandatory.
The list of allowed options (only for select or radio fields).
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
FK back to the parent CustomField.
The user-facing label for this option.
128The stored value for this option (often same as Label).
64Sort order among siblings.
0 <= x <= 2147483647Placeholder text shown when the field is empty (for text/textarea).
256Help text displayed under the field.
512Represents a dynamically generated or configurable URL associated with a variant.
2048An optional message associated with the delivery of this variant.
4096Miscellaneous metadata associated with the variant, this is used in migration to tie reviews/products
1000The name of the product. This field is required and must be between 3 and 128 characters in length.
3 - 128A detailed description of the product, used to provide additional information or context about the product.
1 - 16384List of product visibility (or privacy) levels
0, 1, 2 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.
The identifier of the store to which the product belongs.
Represents the identifier of the user associated with the product.
1 - 36Determines 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.
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.
Indicates whether the product is marked as a bestseller.
The list of payment gateways that are blacklisted and should not be used for processing payments for this product.
A unique identifier for the product, used to generate user-friendly URLs.
1 - 72Custom metadata set by either the user or the system to store additional information about the product
10000Was this page helpful?