List Sale Types - Clopos Open API

This endpoint retrieves a list of all available sale types, such as In-store, Delivery, and Takeaway. Sale types represent the fulfillment channel for an order (e.g., dine-in, delivery, takeaway) and may determine service charge behavior.

The status object is a venue map. Its keys are venue_id strings and the values indicate enablement at that venue: 1 = enabled, 0 = disabled. For example, status["1"] = 1 means this sale type is enabled for venue 1.

Used by

Create Order: provide payload.service.sale_type_id and payload.service.venue_id

Response Example

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Yerinde",
      "system_type": "IN",
      "channel": "IN",
      "status": {
        "1": 1,
        "2": 1,
        "3": 1
      },
      "service_charge_rate": null,
      "position": 0,
      "media": [],
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z"
    },
    {
      "id": 2,
      "name": "Catdirilma",
      "system_type": "DELIVERY",
      "channel": "DELIVERY",
      "status": {
        "1": 1,
        "2": 1,
        "3": 1
      },
      "service_charge_rate": null,
      "position": 0,
      "media": [
        {
          "urls": {
            "original": "https://cdn.clopos.com/_clopos/delivery.png",
            "large": "https://cdn.clopos.com/_clopos/delivery.png"
          }
        }
      ],
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z"
    },
    {
      "id": 3,
      "name": "Takeaway",
      "system_type": "TAKEAWAY",
      "channel": "TAKEAWAY",
      "status": {
        "1": 1,
        "2": 1,
        "3": 1
      },
      "service_charge_rate": null,
      "position": 0,
      "media": [
        {
          "urls": {
            "original": "https://cdn.clopos.com/_clopos/takeaway.png",
            "large": "https://cdn.clopos.com/_clopos/takeaway.png"
          }
        }
      ],
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z"
    }
  ],
  "total": 3
}

Field Reference

Sale Type Object

Field	Type	Description
`id`	integer	Unique identifier for the sale type.
`name`	string	Display name of the sale type (e.g., “In-store”, “Delivery”).
`system_type`	string	System-defined type identifier: `IN`, `DELIVERY`, `TAKEAWAY`.
`channel`	string	Sales channel this type belongs to.
`status`	object	Map of `venue_id` (string) to `0`/`1` indicating whether this sale type is enabled at each venue.
`service_charge_rate`	number (nullable)	Service charge rate associated with this sale type, or `null` if none.
`position`	integer	Display order position.
`media`	array	Image attachments. See Media object.
`created_at`	string	Creation timestamp (ISO 8601).
`updated_at`	string	Last update timestamp (ISO 8601).