Skip to main content
GET
/
products
/
{id}
Get product by ID
curl --request GET \
  --url https://integrations.clopos.com/open-api/products/{id} \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "id": 123,
  "type": "GOODS",
  "name": "<string>",
  "full_name": "<string>",
  "status": 123,
  "price": 123,
  "cost_price": 123,
  "has_modifications": true,
  "modifications": [
    {
      "id": 123,
      "parent_id": 123,
      "type": "MODIFICATION",
      "name": "<string>",
      "price": 123,
      "cost_price": 123,
      "barcode": "<string>",
      "full_name": "<string>",
      "status": 123
    }
  ],
  "modificator_groups": [
    {
      "id": 123,
      "name": "<string>",
      "type": 123,
      "min_select": 123,
      "max_select": 123,
      "modificators": [
        {
          "id": 123,
          "name": "<string>",
          "price": 123,
          "cost_price": 123,
          "max_count": 123,
          "status": true,
          "ingredient": "<unknown>"
        }
      ]
    }
  ],
  "recipe": [
    {
      "id": 123,
      "type": "PREPARATION",
      "name": "<string>",
      "cost_price": 123,
      "pivot": {
        "gross": "<string>"
      }
    }
  ],
  "packages": [
    {
      "id": 123,
      "name": "<string>",
      "equal": 123
    }
  ],
  "setting": {
    "interval": 123,
    "prices": [
      {
        "price": 123,
        "from": 123
      }
    ]
  },
  "taxes": [
    {
      "id": 123,
      "name": "<string>",
      "rate": 123
    }
  ],
  "tags": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-token
string
header
required

Access token obtained from /auth endpoint

x-brand
string
header
required

Brand identifier

x-venue
string
header
required

Venue identifier

Path Parameters

id
string
required

Product ID

Response

Product retrieved successfully

id
integer
type
enum<string>

The type of the product.

Available options:
GOODS,
DISH,
TIMER,
PREPARATION,
INGREDIENT,
MODIFICATION
name
string
full_name
string
status
integer
price
number
cost_price
number
has_modifications
boolean

True if the product has variants (modifications).

modifications
object[]

List of product variants (for GOODS).

modificator_groups
object[]

List of modifier groups (for DISH).

recipe
object[]

List of recipe items (for DISH or PREPARATION).

packages
object[]

List of purchasing packages (for INGREDIENT).

setting
object

Pricing rules for TIMER products.

taxes
object[]
tags
object[]
created_at
string<date-time>
updated_at
string<date-time>