Get Product by Slug

Retrieves a product by its slug. Requires the stores.products.view permission.

GET /stores/{storeId}/products/slug/{slug}

Get product by slug

cURL

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

200

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

Authorizations

Authorization · string · header · required

Your API key goes here

Path Parameters

storeId · string<uuid> · required

The ID of the store the product belongs to.

slug · string · required

The slug of the product to retrieve.

Response

200

application/json

The object was successfully returned.

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 product that belongs to a specific store and contains details such as name, description, visibility, and associated information.

Show child attributes