Get Products

Paginate products

curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/products \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "pages": 123,
  "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": {},
      "stock": 123,
      "slug": "<string>",
      "metadata": "<string>"
    }
  ]
}

GET

stores

{storeId}

products

Paginate products

curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/products \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "pages": 123,
  "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": {},
      "stock": 123,
      "slug": "<string>",
      "metadata": "<string>"
    }
  ]
}

Filterable Fields

This endpoint supports filtering and sorting. See the Filtering & Sorting Guide for syntax details.

Field	Type	Description
`visibility`	integer	Filter by privacy level. See Product Privacy
`isBestSeller`	boolean	Filter best-seller products
`shouldBlockVpns`	boolean	Filter products that block VPNs
`lowStock`	boolean	Filter products with low stock availability

Example:

# Public best-sellers with low stock
GET /api/stores/{storeId}/products?filters=visibility==0,isBestSeller==true,lowStock==true

# Products that don't block VPNs
GET /api/stores/{storeId}/products?filters=shouldBlockVpns==false

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

The ID of the store.

Query Parameters

Visibility

enum<integer>

Filter by visibility (Public / Unlisted / Private). List of product visibility (or privacy) levels

Available options:

0,

1,

2

IsBestSeller

boolean

Show only best-sellers (true) or non-best-sellers (false).

ShouldBlockVpns

boolean

Filter on whether VPNs are blocked for the product.

LowStock

boolean

Filter by products that have low stock availability.

Filters

string

Sorts

string

Page

integer<int32>

Required range: 1 <= x <= 2147483647

PageSize

integer<int32>

Required range: 1 <= x <= 2147483647

Response

The object was successfully returned.

Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.

success

boolean

required

Indicates whether the operation was successful

pages

integer<int32>

required

The total number of pages available in the paginated response.

data

object[]

required

Represents the collection of items within a paginated response

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.variants

object[]

required

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

Show child attributes

data.variants.id

string<uuid>

required

The unique identifier of the entity

data.variants.dateCreated

string<date-time>

required

The date the entity was created in the database

data.variants.name

string

required

The name of the variant.

Required string length: 3 - 128

data.variants.productId

string<uuid>

required

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

data.variants.storeId

string<uuid>

required

The unique identifier for the store associated with the variant.

data.variants.cost

number<double>

required

The cost of the variant.

Required range: 0 <= x <= 100000

data.variants.deliveryTypes

string[]

required

A list of delivery methods associated with the variant.

data.variants.files

object[]

required

A collection of stored files associated with this variant.

Show child attributes

data.variants.files.id

string<uuid>

required

The unique identifier of the entity

data.variants.files.dateCreated

string<date-time>

required

The date the entity was created in the database

data.variants.files.friendlyName

string

required

The friendly name of the file

Required string length: 1 - 128

data.variants.files.ipAddress

string

required

The IP address which uploaded the file

Required string length: 1 - 45

data.variants.files.userId

string

required

The ID of the user who uploaded the file

Required string length: 1 - 36

data.variants.minimumQuantity

integer<int32>

required

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

data.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.variants.order

integer<int32>

required

Indicates the display order of the variant in a sequence.

data.variants.imageNames

string[]

required

A list of image file names associated with the variant.

data.variants.stock

integer<int32>

required

Represents the quantity of items available for sale.

data.variants.stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

data.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.variants.customFields.id

string<uuid>

required

The unique identifier of the entity

data.variants.customFields.dateCreated

string<date-time>

required

The date the entity was created in the database

data.variants.customFields.variantId

string<uuid>

required

FK back to the parent Variant.

data.variants.customFields.label

string

required

The display label for this custom field.

Required string length: 1 - 128

data.variants.customFields.identifier

string

required

A machine-friendly identifier used in forms and storage.

Required string length: 1 - 64

data.variants.customFields.type

string

required

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

Required string length: 1 - 256

data.variants.customFields.isRequired

boolean

required

Whether filling out this field is mandatory.

data.variants.customFields.options

object[]

required

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

Show child attributes

data.variants.customFields.options.id

string<uuid>

required

The unique identifier of the entity

data.variants.customFields.options.dateCreated

string<date-time>

required

The date the entity was created in the database

data.variants.customFields.options.customFieldId

string<uuid>

required

FK back to the parent CustomField.

data.variants.customFields.options.label

string

required

The user-facing label for this option.

Maximum string length: 128

data.variants.customFields.options.value

string

required

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

Maximum string length: 64

data.variants.customFields.options.order

integer<int32>

required

Sort order among siblings.

Required range: 0 <= x <= 2147483647

data.variants.customFields.placeholder

string | null

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

Maximum string length: 256

data.variants.customFields.hint

string | null

Help text displayed under the field.

Maximum string length: 512

data.variants.dynamicUrl

string | null

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

Maximum string length: 2048

data.variants.deliveryMessage

string | null

An optional message associated with the delivery of this variant.

Maximum string length: 4096

data.variants.metadata

string | null

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

Maximum string length: 1000

data.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.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.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.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.storeId

string<uuid>

required

The identifier of the store to which the product belongs.

data.userId

string

required

Represents the identifier of the user associated with the product.

Required string length: 1 - 36

data.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.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.isBestSeller

boolean

required

Indicates whether the product is marked as a bestseller.

data.blacklistedPaymentGateways

string[]

required

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

data.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.additionalFees.{key}

string

data.stock

integer<int32>

required

The amount of stock the product has in total

data.slug

string | null

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

Required string length: 1 - 72

data.metadata

string | null

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

Maximum string length: 10000

Get All Products

Create Product

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Filterable Fields

Authorizations

Path Parameters

Query Parameters

Response

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

​Filterable Fields

Authorizations

Path Parameters

Query Parameters

Response

Filterable Fields