Get all purchase item types
Get a list of purchase item types accepted in the CareCloud platform. Each type determines how CareCloud processes the item within a purchase, including which loyalty rules and discounts apply.
Note: Type names may vary between CareCloud projects and can be customized per deployment. The names listed here are approximate references only. Always use type_id to identify a purchase item type in your integration — do not rely on the name.
Often used types
Transaction in a store The standard type for items purchased in a brick-and-mortar retail store. This is the most commonly used type for in-store transactions. All standard loyalty and discount rules apply.
E-commerce transaction The standard type for items purchased through an online store or e-commerce channel. This is the most commonly used type for online transactions. All standard loyalty and discount rules apply.
Cancel Used to mark canceled purchase items. Assigning this type to an item identifies it as a cancellation within the purchase, making it easier to track and process.
Special types with effects
These types alter the default loyalty and discount behavior in CareCloud.
Item without reward application Items of this type are excluded from all reward and discount calculations — no discounts or rewards can be applied. However, loyalty points can still be collected for these items, and customers can use loyalty points to pay for them.
OTC without loyalty Over-the-counter (OTC) refers to products sold without a prescription, most commonly in pharmacy retail. In wider retail contexts, the term also covers items sold at a service counter that are typically excluded from promotions, such as tobacco, lottery tickets, or gift cards. Items of this type do not earn loyalty points and are not eligible for any discounts or rewards.
Point payments only Items of this type can only be paid for using loyalty points. No discounts or rewards are applied.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
You can filter resource results depending on his text ID.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"purchase_item_types": [
{
"type_id": "86e05affc7a7abefcd513ab400",
"name": "Store purchase",
"text_id": "store_purchase"
}
],
"total_items": 1
}
}