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 GET \
--url https://api.komerza.com/stores/{storeId}/categories/all \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"name": "<string>",
"visibility": 0,
"order": 123,
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productCount": 123,
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"imageNames": [
"<string>"
],
"rating": 123,
"order": 123,
"visibility": 0,
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": 123,
"minimumQuantity": 123,
"maximumQuantity": 123,
"order": 123,
"requireDiscordAuthorization": true,
"type": 0,
"deliveryTypes": [
"<string>"
],
"imageNames": [
"<string>"
],
"stock": 123,
"stockMode": 0,
"customFields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"identifier": "<string>",
"type": "<string>",
"isRequired": true,
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"value": "<string>",
"order": 123
}
],
"placeholder": "<string>",
"hint": "<string>"
}
],
"subscriptionPeriod": "<string>",
"subscriptionId": "<string>"
}
],
"isBestSeller": true,
"slug": "<string>",
"metadata": "<string>"
}
],
"slug": "<string>"
}
]
}Get All Categories
Retrieves all categories in the store as references (no pagination).
Requires the stores.categories.view permission.
curl --request GET \
--url https://api.komerza.com/stores/{storeId}/categories/all \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"name": "<string>",
"visibility": 0,
"order": 123,
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productCount": 123,
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"imageNames": [
"<string>"
],
"rating": 123,
"order": 123,
"visibility": 0,
"storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": 123,
"minimumQuantity": 123,
"maximumQuantity": 123,
"order": 123,
"requireDiscordAuthorization": true,
"type": 0,
"deliveryTypes": [
"<string>"
],
"imageNames": [
"<string>"
],
"stock": 123,
"stockMode": 0,
"customFields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"identifier": "<string>",
"type": "<string>",
"isRequired": true,
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"value": "<string>",
"order": 123
}
],
"placeholder": "<string>",
"hint": "<string>"
}
],
"subscriptionPeriod": "<string>",
"subscriptionId": "<string>"
}
],
"isBestSeller": true,
"slug": "<string>",
"metadata": "<string>"
}
],
"slug": "<string>"
}
]
}Authorizations
Your API key goes here
Path Parameters
The ID of the store to get the categories from
Response
The object was successfully returned.
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
The data object encapsulated within the response, representing the core output of the API operation
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created
The name of the category
List of product visibility (or privacy) levels
0, 1, 2 The ordering index of the category
The unique identifier of the store associated with the category
The count of products in this category
The list of products in the category
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created
The display name of the product reference.
A textual description of the product
The names of the images associated with the product
The average rating of the product.
The order in which a product is displayed or sorted
List of product visibility (or privacy) levels
0, 1, 2 The unique identifier of the store associated with the product.
The collection of product variants associated with the product.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created
The name of the variant
3 - 128The ID of the product the variant belongs to
The ID of the store the variant belongs to
The amount of money the product costs
The minimum amount of items allowed to be purchased for the product
The maximum amount of items allowed to be purchased for the product, -1 equals infinity
The ordering number of the product variant, used by the frontends. Defaults to 1
Whether the product requires the user to authorize to Discord to purchase it
The type of product that is being sold
0, 1 The list of enabled delivery types for the variants Can be: license_keys, dynamic, instructions, files
The list of image names that will be displayed for the product, if not set inherits from the product it belongs to
The amount of stock the product has. This number is influenced by the Komerza.Common.Models.Products.PublicVariant.StockMode
The stock calculation modes that are used
0, 1, 2 The list of custom fields that will be displayed for this variant
Show child attributes
Show child attributes
The unique ID of this custom field.
The ID of the variant to which this field belongs.
The display label for this custom field.
A machine‐friendly identifier.
The type of the field (text, textarea, select, etc.).
Whether filling out this field is mandatory.
The list of allowed options (for select or radio types).
Show child attributes
Show child attributes
The unique ID of this option.
The ID of the custom field to which this option belongs.
The user-facing label for this option.
The stored value for this option.
Sort order among sibling options.
Placeholder text shown when the field is empty.
Help text displayed under the field.
The timespan of the subscription
The ID of the Stripe subscription used if the product is a subscription product AND they have Stripe enabled
256Indicates whether the product is marked as a bestseller.
The URL-friendly identifier for the product
Custom metadata set by either the user or the system to store additional information about the product
The URL-friendly identifier for the category
Was this page helpful?