Get Products

Retrieves products in pages. Requires the stores.products.view permission.

GET /stores/{storeId}/products

Paginate products

cURL

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

200

{
  "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,
          "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": {},
      "stock": 123,
      "slug": "<string>",
      "metaDescription": "<string>",
      "metadata": "<string>",
      "customAffiliateDiscountPercentage": 50,
      "subscriptionAllowPause": true,
      "subscriptionMaxPauseDurationDays": 123,
      "subscriptionMaxPauseCount": 123,
      "subscriptionAllowCancel": true,
      "subscriptionAllowReactivate": true,
      "subscriptionGracePeriodDays": 123,
      "subscriptionRevokeOnExpiry": true
    }
  ]
}

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 / OnHold). List of product visibility (or privacy) levels

Available options: 0, 1, 2, 3

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

200

application/json

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 · read-only

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