Structures

List of all available REST API CRM CareCloud resources.

Accepted payment structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
recommended_discounts DiscountItem[] The list of offered discounts excludes rewards (Loyalty Status Discount) No Yes
credit_points float Amount of used points No Yes
price_of_credit_points float Amount of money corresponding to the number of used points No Yes
credit float Amount of used credits No Yes
vouchers PaymentVoucher[] List of applied vouchers on the current bill (includes the value of discount) independent of DiscountItem No Yes
credit_points_of_this_transaction float Sum of points gained from this transaction No Yes
total_credit_points float Amount of the points on the customer account (after the recent purchase is closed) No Yes
total_credit float Amount of the credits on the customer account (after the recent purchase is closed) No Yes
messages CashierMessage[] A recommendation messages for the cashier in his language localization No Yes

Address structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
address1 string Street name of the address No No
address2 string Street number (Land registry number) No No
address3 string House number No No
address4 string Next address data No No
address5 string Next address data No No
address6 string Next address data No No
address7 string Next address data No No
zip string ZIP code No No
city string City No No
country_code string ISO code of the country
Possible values de / gb / us / it / cz / etc.
No No

Agreement structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
agreement_gtc integer Consent to General Terms & Conditions
Possible values: 0 - no, consent canceled / 1 - yes, consent given / 2 - consent not set
No No
agreement_profiling integer Consent to profiling
Possible values: 0 - no, consent canceled / 1 - yes, consent given / 2 - consent not set
No No
agreement_marketing_communication integer Consent to marketing communication
Possible values: 0 - no, consent canceled / 1 - yes, consent given / 2 - consent not set
No No
custom_agreements CustomAgreement[ ] Custom agreements No No

Agreement list structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
agreement_id string The unique id of the agreement in CareCloud No Yes
name string Name of the agreement in CareCloud No Yes
text string Text of the agreement in CareCloud. Language version of text is returned by language setup in HTTP header of the request. No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Bill structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
bill_id string Identification number of the bill (must be unique in POS, use prefix 'C' for a canceled bill) Yes No
bill_number string Alternative identification of the bill. In the case of cancelation, there should be bill_id from the original bill. No No
payment_time string Date and time of bill creation
Possible value: 2016-06-30T15:51:49+02:00
Yes No
created_by string Name of the user who created a bill No No
currency_id string Id of the currency from resource currencies Yes No
total_price float The total price of the bill as a sum of all items Yes No
utm UTM UTM structure for data from email campaign No No
bill_items BillItem[ ] List of bill items Yes No

Bill item structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
plu_ids PluId[] An array of all available pluIds from the particular product lists (default is Product ID from Global product list (consist cleaned data - unique id for every product across all POS systems)) Yes No
plu_name string Product name Yes No
category_plu_id string Product category ID from Global product list (consist cleaned data - unique id for every category across all POS systems) Yes No
vat_rate float VAT rate of the item Yes No
quantity float Quantity of product Yes No
paid_amount float Real money value (unit price * quantity) paid by the customer (The value for a pharmaceutical client could have a copayment for drug prescription or money value of drugs not covered by an insurer). Yes No
price float Value of parameter "paid_amount". In the case of a pharmaceutical client, add to the value of "paid_amount" a value of money covered by the customer's health insurance. Yes No
bill_item_id string ID of the bill item Yes No
loyalty_off boolean Switch off all loyalty benefits (points, discounts- instant and campaign prices, vouchers) on the item Yes No
purchase_item_type_id integer Type of the purchase item from resource purchase-item-types Yes No
customer_id string The ID of the customer No No

Campaign structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
campaign_id string The unique id of the campaign No Yes
external_id string The external id of the campaign No No
parent_id string Id of the parent campaign No No
name string Name of the campaign Yes No
state integer State of the campaign
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Campaign presentation data structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
name string Name of the product Yes No
subtitle string Text of the campaign product subtitle No No
note string Text of the campaign product note No No
description string Text of the campaign product description No No
image_url string URL address of the image No No

Campaign product structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
campaign_product_id string The unique id for the campaign product No Yes
product_id string The unique id for the product Yes No
currency_id string The unique id for the currency Yes No
campaign_id string The unique id for the campaign Yes No
value float Value of the product Yes No
value_type_id integer Type of value (1 - percentage discount value, 2 - final price) Yes No
valid_from string Valid from
(YYYY-MM-DD HH:MM:SS)
Yes No
valid_to string Valid to
(YYYY-MM-DD HH:MM:SS)
Yes No
display_in array List of possible display places No No
type_id string Type of a campaign product Yes No
presentation_data CampaignPresentationData Structure of data for presentation Yes No
state integer State of the campaign product
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Campaign product store record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
campaign_product_store_record_id string The unique id for the campaing product store record. No Yes
store_id string The unique id of the store. Yes No
campaign_product_id string The unique id of the campaign product. Yes No

Cashier message structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
text string Text of the message No Yes

Customer type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
type_id string The unique id of the customer type No Yes
name string Name of the customer type No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Card structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
card_id string The unique id for the card No Yes
customer_id string The unique id for the card holder. No No
card_type_id string The unique id for the card type. Yes No
card_number string Card number Yes No
valid_from string Card validity from
(YYYY-MM-DD HH:MM:SS)
No No
valid_to string Card validity to
(YYYY-MM-DD HH:MM:SS)
No No
store_id string The unique id for the store, where the card was assigned to a customer No No
state integer State of the card
Possible values are: 0 - blocked / 1 - active
Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Card type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
card_type_id string The unique id for the card type No Yes
name string Name of the card type Yes No
prefix string Prefix of the specific card type cards Yes No

Currency structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
currency_id string The unique id for the currency Yes Yes
name string Name of the currency Yes No
code string International ISO code of the currency Yes No

Custom Agreement structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
agreement_id string The unique id of the agreement in CareCloud Yes No
agreement_value integer Value of the specific agreement
Possible values: 0 - no, consent canceled / 1 - yes, consent given / 2 - consent not set
Yes No

Customer relation type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
customer_relation_type_id string The unique id of the customer relation type No Yes
name string Name of the customer relation type Yes No
state integer State of the customer relation type
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Customer result structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
customer_id string The unique id of the customer No Yes
match integer Percentage of match of the search parameters No Yes

Customer search result structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
strict CustomerResult[] Search results for strict mode No Yes

Customer structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
customer_id string The unique id of the customer No Yes
personal_information PersonalInformation Personal information of the customer Yes
state integer State of the customer
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Customer source record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
customer_source_id string The unique id of the customer source. It identifies the system where the customer belongs or the customer account was created Yes No
customer_id string The unique id of the customer No Yes
external_id string The unique external id of the customer. It may be id from the other system No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Customer source structure

Structure is dedicated for resource customer-sources.

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
customer_source_id string The unique id of the customer source Yes No
name string Name of the customer source Yes No
state integer State of the customer source
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Device structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
device_id string The unique id of the client device Yes No
device_system string Operation system of the device Yes No
device_name string The name of the device Yes No
device_type string Type of device by producer (product line) Yes No

Discount item structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
discount_code string Code of discount (set value “offline” for offline mode discounts) No No
discount_value string Value of discount in the currency of the bill No No
description string Text description of the discount reason No No
bill_item_id string ID of the related bill item No No

Error structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
exception string Content of the exception Yes No
title string The title of the error Yes No
detail string The details of the error message Yes No
error_data any Data in case of an exception No No

Event structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
event_id string The unique id of the event No Yes
event_type_id string The unique id of the event type Yes No
customer_id string The unique id of the customer Yes No
external_id string The unique external id of the event. It may be id from other system Yes No
data string Additional data of the event. Serialized data in JSON No No
state integer State of the event type
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
created_at string Date and time of the event
(YYYY-MM-DD HH:MM:SS)
No No
secondary_external_id string Additional external id of the event. It's used in case, when differentiation of external_id needed No No

Event group structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
event_group_id string Id of the event type group Yes No
name string Name of the event type No No
state integer State of the event type
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
text_id string Text id of an event group No Yes

Event type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
event_type_id string The unique id of the event type Yes No
event_group_id string Id of the event type group Yes No
name string Name of the event type No No
state integer State of the event type
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes

External application structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
external_application_id string The unique id of the client external application Yes No
name string The name of the external application Yes No
state integer State of the external application
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

External code structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
external_code_type_id integer The unique id of the external code type (provided by your account manager)
Default value: 1
Yes No
value string Value of external code Yes No

Final bill structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
fiscal boolean Information, whether it is a fiscal bill Yes No
purchase_type_id integer Type of the purchase. Values are available in resource purchase-types Yes No
canceled boolean Information, whether it is the cancellation of the purchase. It is the only parameter that identifies the canceled purchase. All other values are the same as in the original bill. No different values like totalPrice, quantity, paidAmount, and itemPrice are changed nor inverted. Yes No
payment_type string The method of the bill closure.
Possible values are: “S”-standard / “P”- use points for payment / “C”- use credits for payment / “D”- use discount now
Yes No
payment_recap PaymentRecap Alternative payment methods summary No No
bill_id string Identification number of the bill (must be unique in POS, use prefix 'C' for a canceled bill) Yes No
bill_number string Alternative identification of the bill. In the case of cancelation, there should be bill_id from the original bill. No No
payment_time string Date and time of bill creation
Possible value: 2016-06-30T15:51:49+02:00
Yes No
created_by string Name of the user who created a bill No No
currency_id string The international currency code Yes No
total_price float The total price of the bill as a sum of all items Yes No
bill_items BillItem[ ] List of bill items Yes No
utm UTM UTM parameters No No

Flag structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
name string Name of the flag Yes No
text_id string The unique id for the flag Yes No

GPS coordinates structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
gps_longitude float GPS longitude Yes No
gps_latitude float GPS latitude Yes No

Interest structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
interest_id string The unique id for the interest No Yes
name string Name of the interest No Yes

Interest record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
interest_record_id string The unique id for the interest record No Yes
interest_id string The unique id of the interest Yes No
customer_id string The unique id of the customer Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Language structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
language_id string The unique id of the language code by ISO 639-1 No Yes
state integer State of the point record
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes

Message structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
message_id string The unique id of the message No Yes
status string The status id of the message.
Possible values are: 0 - message was not send / 1- message was send successfully / -1 message was not recieved (it was returned) / 2 - an error occured while sending / 4 - customer has no agreements (GDPR)
No Yes
message_template_id string The unique id of the message_template Yes No
customer_id string The unique id of the customer Yes No
contact string Email address or phone number of customer in case of send message to different contact than customer has in database No No
title string Subject of the email message/ Title of notification message / Preview of the text message . Mandatory only in case of email template No Yes
send_time string Date and time when message was send from server to recipient
(YYYY-MM-DD HH:MM:SS)
No Yes
opened_time string Date and time when message was opened by recipient
(YYYY-MM-DD HH:MM:SS)
No Yes
send_time string Date and time when message was send from server
(YYYY-MM-DD HH:MM:SS)
No Yes
mail_client_user_agent string User agent of the mail client application where message was opened No Yes
mail_client_language string Language of the mail client application where message was opened No Yes
communication_channel_id string The unique id of the communication channel.
Possible values are: 1 - email / 2- SMS / 4 - PUSH notification (Apple or Google) / 5 - internal system notification
Yes No
message_data Parameter[] Message data could contains array of customized paramteres. They may have influence on message display or add values to message No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Message detail structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
plain_text_body string Plain text body of the message Yes Yes
html_body string HTML body of the message Yes Yes

Message template structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
message_template_id string The unique id of the message template No Yes
consent_free_template boolean If true, customer can recieve message without any consent(GDPR, etc.) No No
subject string Subject of the message template. Mandatory only in case of email template Yes Yes
sender string Sender of the message template Yes Yes
name string Name of the message template Yes Yes
message_template_group_id string The unique id of the message template group.
_Possible values are: 1 - newsletter template / 2- system template(registration message, order summary message, etc.) / 3 - transactional communication(for hotel, traveling,...)
Yes Yes
comunication_channel_id string The unique id of the communication channel.
Possible values are: 1 - email / 2- SMS / 4 - PUSH notification (Apple or Google) / 5 - internal system notification
Yes Yes
template_data Parameter[] Template data could contains array of customized paramteres. They may have influence on template display or add values to template No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Opening day structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
day_id string The unique id of the day of the week Yes No
time_intervals TimeInterval[] Time Interval structure Yes No

Order structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
order_id string The unique id of the order No Yes
order_number string External order number. If not set, internal order number will be set No No
customer_id string The unique id of the customer, owner of the order Yes No
currency_id string Id of currency Yes No
total_price float Total price of the order Yes No
discount_codes string[] Discount codes used in order No No
order_items OrderItem[] List of the OrderItems Yes No
invoicing_data OrderInvoicing Structure of OrderInvoicing. Contains neccessery data for invoicing of the order Yes No
shipping_data OrderShipping Structure of OrderShipping. Contains neccessery data for shipping of the order No No
customer_note string Customer’s note for the merchant No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Order item structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
order_item_id string The unique id of the order item No Yes
product_variant_id string The unique id of the webshop product Yes No
customer_id string The unique id of the customer, owner of the order item. If not set, customer_id from order will be saved No No
amount float Amount of products in order item Yes No
unit_price float Unit price of the ordered product Yes No
vat_rate float The rate of the VAT of the ordered product Yes No

Order invoicing structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
payment_id string The unique id of the payment Yes No
paid_date string Date and time of the order payment
(YYYY-MM-DD HH:MM:SS)
No No
personal_information PersonalInformation Personal information of the customer No No

Order shipping structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
shipping_id string The unique id of the Yes No
contact_name string Name of the contact for shipping No No
phone string Phone number of the contact with international prefix (420000000) No No
address Address Address of the customer No No

Parameter structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
parameter_name string Name of the paramter Yes No
value string Value of the parameter Yes No

Partner structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
partner_id string The unique id of the company No Yes
name string Name of the company Yes No
address Address Address of the company No No
registration_id string Company registration number. National Registration unique id for the company. No No
vat_id string VAT registration number. Value Added Tax unique id for the company. No No
email string Email of the company No No
phone string Phone number of the company with international prefix (420000000) No No
state integer State of the partner
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes

Payment recap structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
credit_points float Amount of the points used for payment of the bill No Yes
amount_for_credit float Amount of the credits used for payment of the bill No Yes
vouchers PaymentVoucher[] List of used vouchers for payment of bills No Yes
recommended_discounts DiscountItem[] List of applied discounts where the service did not use the voucher No Yes

Payment voucher structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
code string Code of a reward or a voucher used in purchase No Yes
name string Name of the reward No Yes
discount_value float Value of discount in the currency of the bill No Yes
discount_percent float Value of discount in percent No Yes
bill_item_id string ID of the related bill item No Yes

Personal Information structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
gender integer Gender of the customer
Possible values: 1 - male, 2 - female
No No
first_name string First name of the customer No No
last_name string Last name of the customer No No
birthdate string Customer's date of birth (YYYY-MM-DD) No No
email string Email of the customer No No
phone string Phone number of the customer with international prefix (420000000) No No
language_id string The unique id for the language by ISO 639 code Yes No
store_id string The unique id for the original customer account store of registration No No
photo_url string URL address of the customer photo. If customer has no photo, this parameter is not send No Yes
address Address Address of the customer No No
agreement Agreement Customer's consents No No

PLU Id structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
list_code string Code of the particular product list (basic is code of Global product list (consist cleaned data - unique id for every product across all POS systems)). For example, “GLOBAL”, “SKU”, “PLU”, etc. Yes No
code string Code of product from the product list (basic is Product ID from Global product list (consist cleaned data - unique id for every product across all POS systems)) Yes No

Point structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
point_id string The unique id for the point record No Yes
customer_id string The unique id for the customer Yes No
assigned_points float The number of earned points No Yes
available_points float The number of points available actually taking into account the eventual points redemption No Yes
point_type_id string Type of the point record Yes No
partner_id string The unique id for the partner company Yes No
state integer State of the point record
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
valid_to string Date and time of the point record validity to
(YYYY-MM-DD HH:MM:SS)
No No

Points reservation structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
points_reservation_id string The unique id of the point reservation record No Yes
customer_id string The unique id of the customer Yes No
external_id string The external unique id of the product brand Yes No
quantity float The number of reserved points Yes No
partner_id string The unique id of the partner company Yes No
state integer State of the point record
Possible values are: 0 - deleted / 1- active / 2 - non active(expired)
No Yes
expiration string Date and time of the point reservation expiration
(YYYY-MM-DD HH:MM:SS)
No No

Point type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
point_type_id string The unique id of the point type No Yes
name string Name of the point type No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Product brand structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
product_brand_id string The unique id of the product brand No Yes
name string Name of the product Yes No
external_id string The external unique id of the product brand Yes No

Product group structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
product_group_id string The unique id of the product group No Yes
name string Name of the product Yes No
parent_product_group_id string The unique id for the parent product group No No
code string Code of the product Yes No
external_id string The external unique id for the product Yes No
store_id string The unique id for the store where the product group is valid. The product group is global if this value is not set No No
state integer State of the product group
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Product reservation structure

Structure has to contain reservation codes or product reservation items

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
product_reservation_id string The unique id of the product reservation No Yes
customer_id string The unique id of the customer, owner of the product reservation Yes No
store_id string The unique id of the store tied to the reservation Yes No
reservation_codes string[] Ids of the reservation No Yes
external_reservation_codes ExternalCode[] List of external id codes. Id codes can have different sources. For the list of id sources please contact your account manager. No No
benefit_codes string[] List of the benefit (rewards, vouchers) codes used in a reservation. After the reservation is delivered, all benefits are applied on the customer's account No No
product_reservation_source_id string The unique id of the product reservation source Yes No
pickup_date string Date of the reservation pickup in the tied store
(YYYY-MM-DD)
No Yes
customers_note string Customer’s note for the merchant No No
total_price float Total price of reservation If currency_id, than total_price is mandatory No No
currency_id string Id of the currency. If total_price is set, than currency_id is mandatory No No
product_reservation_items ProductReservationItem[] List of the Product Reservation Items No No
external_purchase_id string The unique external id of the purchase No No
utm UTM UTM structure for data from email campaign No No
state integer State of the product reservation
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes
actual_state string Actual state of the product reservation.
Possible values: 0 - Canceled / 1 - Entered / 2 - Accepted / 3 - Ready / 4 - Delivered / 5 - In progress / 6 - Not Picked up / 7 - Ordered / 8 - Being solved /
No Yes
states string[] History of the state values. States are sorted in descending order by time No Yes
comments string[] Reservation comments. Comments are sorted in descending order by time No Yes

Product reservation source structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
product_reservation_source_id string The unique id of the product reservation source No Yes
name string Name of the product reservation source in defined language(depends on language in http header of the API request) No Yes
state integer State of the product reservation
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Product reservation item structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
reservable_product_id string The unique id of the reservable product in CareCloud Yes No
amount float Number of the reserved products Yes No
unit_price float Unit price of the reserved product. If vat_rate is set, than unit_price is mandatory No No
vat_rate float The rate of the VAT of the reserved product. If unit_price is set, than vat_rate is mandatory No No

Product structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
product_id string The unique id of the product No Yes
name string Name of the product Yes No
code string Code of the product Yes No
external_id string The external unique id of the product Yes No
product_group_id string The unique id for the product group No No
product_brand_id string The unique id for the product brand No No
additional_properties PropertyRecord[] List of additional properties No No
state integer State of the product
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Property record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
property_record_id string The unique id of the property record No Yes
property_id string The unique id of the property Yes No
property_name string Name of the property No Yes
property_value mixed Value of the property Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Property structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
property_id string The unique id of the property No Yes
name string Name of the property Yes No
description string User defined description of the property No No
data_type string Data type of the final value
Possible values: string / boolean / integer / date / timestamp / float / customized data types
Yes No
items string List of possible values. Used for multivalued data types ( like enum, multiselect) No No
is_required boolean The settings whether the property is a required parameter of the specific entity Yes No
is_unique boolean The setting whether the property contains a unique value within the specific entity Yes No
state integer State of the property
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Purchase conditions structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
keep_status_turnover QualificationTurnover[] Missing turnover to keep current status in every active currency No Yes
next_status_turnover QualificationTurnover[] Missing turnover to the next status in every active currency No Yes
next_status_id string Id of the following status. No Yes

Purchase structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
purchase_id string The unique id of the purchase No Yes
customer_id string The unique id of the customer Yes No
store_id string The unique id of the store in CareCloud Yes No
external_id string The external unique id of the purchase Yes No
payment_time string Date and time of the purchase payment
(YYYY-MM-DD HH:MM:SS)
Yes No
items_count integer Count of the purchase items Yes No
purchase_items PurchaseItem[] List of all items of the purchase. Data is returned if query parameter purchase_items_extension has value true in the query string of the request. No Yes
type_id string Purchase type Yes No
total_price float Total price of the purchase Yes No
currency_id string The unique id of the currency Yes No
card_number string Purchasing customer card number No No
cashdesk_number string Number of the cashdesk Yes No

|lastchange | string | Date and time of the last change
(YYYY-MM-DD HH:MM:SS)_ | No | Yes |

Purchase item structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
purchase_item_id string The unique id of the purchase item No Yes
product_id string The unique id of the product Yes No
external_id string Identifier of the purchase item in external system No No
purchase_item_type_id string Type of the purchase item Yes No
price float Price of the purchase item Yes No
amount float Amount of the purchase item Yes No
vat_rate float The rate of an item VAT Yes No
additional_properties PropertyRecord[] List of additional properties No No

Purchase item type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
type_id string The unique id of the purchase type No Yes
name string Name of the purchase type Yes No

Purchase type structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
type_id string The unique id of the purchase type No Yes
name string Name of the purchase type Yes No

Qualification turnover structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
currency_id string The unique id of the currency Yes No
value float Value of turnover in the currency Yes No

Recommendation structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
name string Name of a the recommendation Yes No
brief_description string Brief description of the recommendation No No
detailed_description string Detailed recommendation description No No
content string Content of the recommendation as a text No No
picture_urls string[] URL addresses of the pictures of the recommendation No No
web_url string URL address of the recommendation website No No
state integer State of the recommendation
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Recommended reward structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
code string Code of the reward No Yes
name string Name of a the reward No Yes
reward_priority integer Priority of the reward
Value range: 1 - highest, 9 - lowest
No Yes
max_count integer Maximum number of the reward applications No Yes
description string Reward description No Yes
reward_properties RewardProperties Properties of the reward No Yes

Reward properties structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
image string Image of the reward encoded in BASE64 No Yes
valid_time_from string Time the reward is valid from
(HH:MM:SS)
No Yes
valid_time_to string Time the reward is valid to
(HH:MM:SS)
No Yes

Reward structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
reward_id string The unique id of the reward No Yes
code string Code of the reward Yes No
name string Name of the reward Yes No
note string Additional text No No
subtitle string Text of subtitle No No
points_cost float Number of points, that will be spent by the voucher redemption No No
valid_time_from string Time the reward is valid from
(HH:MM:SS)
No No
valid_time_to string Time the reward is valid to
(HH:MM:SS)
No No
reward_group integer The unique id of the reward group
Possible values: 0 - party time voucher / 1 - catalog voucher / 2 - campaign voucher
Yes No
store_list Store[] List of the stores where the reward can be redeemed Yes No
additional_properties PropertyRecord[] Additional properties No No
priority integer Priority of the reward
Possible values: 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / where 1 is the highest priority
No No
image_urls string[] List of reward image URL addresses No Yes
reward_external_url string External URL addresses No Yes
has_product_condition boolean Parameter says, if there is product condition on reward No Yes
has_group_condition boolean Parameter says, if there is group condition on reward No Yes
has_brand_condition boolean Parameter says, if there is brand condition on reward No Yes
is_automated boolean Parameter says, if reward is automated or not. If reward is automated, means it's applied by rules of the reward. Otherwise have to be applied manually No No
state integer State of the reward
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Search result structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
search_result_string string Full text search result Yes No
resource_id string The unique id of the resource as a search result. The unique id depends on resource where the search action was processed Yes No
flags Flag[] List of flags that identify result of the search No No

Segment structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
segment_id string The unique id of the segment No Yes
name string Name of the segment Yes No
note string Short description of the segment No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Segment record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
segment_id string The unique id of the segment Yes No
customer_id string The unique id of the customer Yes No

Setup structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
language_id string The unique id of the language by ISO 639-1 code from languages resource Yes No
allowed_gps boolean Permission to GPS tracking in the mobile application
_(
Yes No
allowed_notifications boolean Permission to the mobile application notifications Yes No

Skipass structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
skipass_id string The unique id of the skipass Yes No
name string Name of the skipass No Yes
customer_id string The unique id of the customer No Yes
resort_name string Name of the resort where is a skipass charged No Yes
customer_category_name string Name of the customer category No Yes
external_order_id string Id of an external order creaded in POS system No Yes
external_skipass_id string External id of skipass. Structure can be different depends of POS system, that created skipass No Yes
skipass_type_id integer Type of the skipass
Possible values are: season ticket - 0/ one day ticket -1/ multiple day ticket - 2
Yes No
order_item_id string Order id item represents relation between skipass and order item from carecloud e-shop No Yes
card_id string Id of card used for charge skipasses Yes No
state string State of the event type
Possible values are: 0 - cancelled / 1- active
Yes No
created_at string Date and time whe skipass was created in CareCloud
(YYYY-MM-DD HH:MM:SS)
No Yes
cancelled_at string Date and time whe skipass was cancelled in CareCloud
(YYYY-MM-DD HH:MM:SS)
No Yes
charged_price float Price charged to POS system No Yes
product_id string The unique id of the product No Yes
charge_date string Date and time when skipass will be charged to the POS system
(YYYY-MM-DD HH:MM:SS)
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Social network credentials structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
social_network_id string The unique id of the social network Yes No
social_network_token string Social network customer's token Yes No

Standard response structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
data any Contains data, that are defined in resource response description No No
error Error Response error structure No No

Status structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
status_id string The unique id of the status No Yes
name string Name of the status Yes No
description string Short description of the status Yes No
qualification_period integer The period of time (in months) in which it is necessary to qualify for the status based on defined conditions. No No
qualification_turnover QualificationTurnover[] The turnover necessary to be met to qualify for the status based on defined conditions. No No
previous_status string The previous status required to qualify for the next status based on defined conditions. The conditions are defined in parameters qualification_period and qualification_turnover. No No
next_status string Id of the following status. No No
validity_period string Definition of the status validity period Yes No
collection_points boolean Enable / disable points collection Yes No
payment_points boolean Enable / disable payment by points Yes No
qualification_type integer The status achieving principle
(1-after creation of the account / 2-manually / 3-after the defined conditions are met)
Yes No
discount integer The basic loyalty discount Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Status record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
status_record_id string The unique id of the status record No Yes
status_id string The unique id of the status Yes No
customer_id string The unique id of the customer Yes No
valid_from string Date and time of the record valid from
(YYYY-MM-DD HH:MM:SS)
No Yes
valid_to string Date and time of the record valid to
(YYYY-MM-DD HH:MM:SS)
No Yes
purchase_conditions PurchaseConditions Structure contains purchase conditions of the status record No Yes
state integer State of the reward
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Store structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
store_id string The unique id of the store in CareCloud Yes Yes
store_code string External code of the store Yes No
name string Name of the store Yes No
store_address Address Address where the store is located No No
contact_email string Contact email of the store No No
manager_name string Name of the store manager No No
phone_number string Phone number of the store No No
partner_id string The unique id for the partner Yes No
system_id string The external unique id of the store in external system Yes No
gps_coordinates GPSCoordinates GPS coordinates of the store No No
url_address string URL address of the store No No
opening OpeningDay[] List of opening days No No
image_urls string[] A list of image URL addresses No Yes
state integer State of the store
Possible values are: 0 - deleted / 1- active / 2 - non active
No Yes
visibility_for_customer integer State of the visibility for the customer
Possible values are: 0 - invisible / 1- visible
No Yes
short_description string Short description of the store No No
description string Long description of the store No No
registration_id string Legal registration number of the store No No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Store group structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
store_group_id string The unique id of the store group No Yes
name string Name of the store group Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Store group record structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
store_group_record_id string The unique id for the store group record. No Yes
store_id string The unique id of the store. Yes No
store_group_id string The unique id of the store group. Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes

Time interval structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
from string Time from
(HH:MM:SS)
Yes No
to string Time to
(HH:MM:SS)
Yes No

User structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
user_id string The unique id of the user No Yes
login string Login id of the user Yes No
first_name string First name of the customer Yes No
last_name string Last name of the customer Yes No
email string Email of the customer Yes No
phone string Phone number of the customer with international prefix (420000000) No No
user_role_id string The unique id of the user role No Yes

User role structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
user_role_id string The unique id of the user role No Yes
name string Name of the user role No Yes

UTM structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
utm_source string Use utm_source to identify a search engine, newsletter name, or other sources. (Example: google) No No
utm_medium string Use utm_medium to identify a medium such as an email or cost-per-click. (Example: cpc) No No
utm_campaign string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. (Example: utm_campaign=spring_sale) No No

Voucher structure

Parameter name Type Description Mandatory (Yes/No) Read only (Yes/No)
voucher_id string The unique id of the voucher Yes Yes
customer_id string The unique id of the customer Yes No
store_id string The unique id of the store where voucher was applied Yes No
code string Code of the voucher Yes No
value float Value of the voucher when applied by the purchase Yes No
applied_date string Voucher application date
(YYYY-MM-DD HH:MM:SS)
No No
valid_from string Date from the voucher is valid
(YYYY-MM-DD HH:MM:SS)
Yes No
valid_to string Date to the voucher is valid
(YYYY-MM-DD HH:MM:SS)
No No
reward_group string The unique id of the reward group Yes No
reward Reward Reward structure Yes No
last_change string Date and time of the last change
(YYYY-MM-DD HH:MM:SS)
No Yes