Skip to main content
GET
/
sale-types
List Sale Types
curl --request GET \
  --url https://integrations.clopos.com/open-api/sale-types \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
[
    {
        "id": 1,
        "system_type": "IN",
        "channel": "IN",
        "status": {
            "1": 1,
            "2": 1,
            "3": 1,
            "4": 1,
            "5": 1,
            "6": 1
        },
        "name": "In-store",
        "payment_method_id": null,
        "service_charge_rate": null,
        "position": 0,
        "created_at": "2022-10-18T10:09:38.000000Z",
        "updated_at": "2024-02-22T06:57:01.000000Z",
        "deleted_at": null,
        "media": [],
        "payment_method": null
    },
    {
        "id": 2,
        "system_type": "DELIVERY",
        "channel": "DELIVERY",
        "name": "Delivery",
        "payment_method_id": null,
        "service_charge_rate": 0,
        "media": [
            {
                "urls": {
                    "original": "https://cdn.clopos.com/_clopos/delivery.png",
                    "large": "https://cdn.clopos.com/_clopos/delivery.png"
                }
            }
        ]
    }
]
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
  • Create Receipt: optionally include sale_type_id or meta.sale_type
[
    {
        "id": 1,
        "system_type": "IN",
        "channel": "IN",
        "status": {
            "1": 1,
            "2": 1,
            "3": 1,
            "4": 1,
            "5": 1,
            "6": 1
        },
        "name": "In-store",
        "payment_method_id": null,
        "service_charge_rate": null,
        "position": 0,
        "created_at": "2022-10-18T10:09:38.000000Z",
        "updated_at": "2024-02-22T06:57:01.000000Z",
        "deleted_at": null,
        "media": [],
        "payment_method": null
    },
    {
        "id": 2,
        "system_type": "DELIVERY",
        "channel": "DELIVERY",
        "name": "Delivery",
        "payment_method_id": null,
        "service_charge_rate": 0,
        "media": [
            {
                "urls": {
                    "original": "https://cdn.clopos.com/_clopos/delivery.png",
                    "large": "https://cdn.clopos.com/_clopos/delivery.png"
                }
            }
        ]
    }
]

​
Sale Type Object

FieldTypeDescription
idintegerThe unique identifier for the sale type.
namestringThe name of the sale type (e.g., “In-store”, “Delivery”).
system_typestring | nullA system-defined type identifier (e.g., “IN”, “DELIVERY”).
channelstringThe sales channel this type belongs to.
service_charge_ratenumber | nullThe service charge rate associated with this sale type.
payment_method_idinteger | nullThe ID of the default payment method for this sale type, if any.
payment_methodobject | nullAn object containing details of the associated payment method.
mediaarrayAn array of media objects, typically containing URLs for icons.
statusobjectMap of venue_id -> 0/1 availability for this sale type.

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

Response

200 - application/json

Sale types retrieved successfully.

​
id
integer
​
name
string
​
system_type
string | null
​
channel
string
​
service_charge_rate
number | null
​
payment_method
object