CRM CareCloud REST API

Getting Started With CareCloud API
Authentication
Tools
FAQ

REST API Reference

Booking tickets
Bookings
Booking statuses
- Get all booking statusesget
- Get a booking statusget
Booking ticket properties
- Get all booking ticket propertiesget
- Get a booking ticket propertyget
Campaigns
Campaign products
Cards
Card types
Charged entrances
Communication channels
- Get all communication channelsget
- Detail of a communication channelget
Consents
- Get all consentsget
- Detail of an consentget
Countries
- Get all countriesget
Credits
Credit history
- Get credit transaction historyget
Credit types
- Get all credit typesget
- Get a credit typeget
Currencies
- Get all currenciesget
- Detail of a currencyget
Customers
Customer engagement
- Get all customer engagement setupsget
- Get a customer engagement setupget
Customers actions
Customer address types
- Get all customer address typesget
- Detail of a customer address typeget
Customer external applications
- Get all customer external applicationsget
- Detail of a customer external applicationget
Customer properties
- Get all customer propertiesget
- Get a customer propertyget
Customer relation types
- Get all customer relation typesget
- Detail of a customer relation typeget
Customer sources
- Get customer sourcesget
- Detail of a customer sourceget
Customer source records
- Get customer source recordsget
Customer types
- Get all customer typesget
- Detail of a customer typeget
Events
Event groups
- Get all event groupsget
- Get an event groupget
Event properties
- Get all event propertiesget
- Get an event propertyget
Event types
Hints
- Get all recommendationsget
- Get a recommendationget
Interests
- Get all interestsget
- Get an interestget
Languages
- Get all languagesget
Messages
Message templates
- Get all message templatesget
- Get a message templateget
One Time Password
- Send a one-time password to a communication channel.post
- Verify a one-time passwordpost
Orders
Partners
Partner properties
- Get all partner propertiesget
- Get a partner propertyget
Payment types
- Get all payment typesget
- Detail of an payment typeget
Points
Point history
- Get point transaction historyget
Point reservation
Point types
- Get all point typesget
- Get a point typeget
Products
Product brands
Product groups
Product properties
- Get all product propertiesget
- Get a product propertyget
Product recommendation engine
Product reservation prices
Product reservations
Product reservation external list types
- Get all product reservation external list typesget
- Detail of a product reservation external list typeget
Product reservation sources
- Get all product reservation sourcesget
- Detail of a product reservation sourceget
Purchase properties
- Get all purchase properties listget
- Get a purchase propertyget
Purchases
Purchase item properties
- Get all purchase item properties listget
- Get a purchase item propertyget
Purchase item types
- Get all purchase item typesget
Purchase types
- Get all purchase typesget
Reservable products
Rewards
Reward properties
- Get all reward propertiesget
- Get a reward propertyget
Reward types
- Get all reward typesget
- Get a reward typeget
Segments
Stamper
Statuses
- Get all statusesget
- Get a statusget
Store properties
- Get all store propertiesget
- Get a store propertyget
Stores
Store groups
- Get all store groupsget
- Get a store groupget
Tasks
Task properties
- Get all task propertiesget
- Get a task propertyget
Tests
- Connection testget
Tokens
Users
User roles
- Get all user rolesget
- Get information about a user roleget
Vouchers
Voucher properties
- Get all voucher propertiesget
- Get a voucher propertyget
Wallet

CRM CareCloud REST API

Getting Started With CareCloud API
Authentication
Tools
FAQ

REST API Reference

Booking tickets
Bookings
Booking statuses
- Get all booking statusesget
- Get a booking statusget
Booking ticket properties
- Get all booking ticket propertiesget
- Get a booking ticket propertyget
Campaigns
Campaign products
Cards
Card types
Charged entrances
Communication channels
- Get all communication channelsget
- Detail of a communication channelget
Consents
- Get all consentsget
- Detail of an consentget
Countries
- Get all countriesget
Credits
Credit history
- Get credit transaction historyget
Credit types
- Get all credit typesget
- Get a credit typeget
Currencies
- Get all currenciesget
- Detail of a currencyget
Customers
Customer engagement
- Get all customer engagement setupsget
- Get a customer engagement setupget
Customers actions
Customer address types
- Get all customer address typesget
- Detail of a customer address typeget
Customer external applications
- Get all customer external applicationsget
- Detail of a customer external applicationget
Customer properties
- Get all customer propertiesget
- Get a customer propertyget
Customer relation types
- Get all customer relation typesget
- Detail of a customer relation typeget
Customer sources
- Get customer sourcesget
- Detail of a customer sourceget
Customer source records
- Get customer source recordsget
Customer types
- Get all customer typesget
- Detail of a customer typeget
Events
Event groups
- Get all event groupsget
- Get an event groupget
Event properties
- Get all event propertiesget
- Get an event propertyget
Event types
Hints
- Get all recommendationsget
- Get a recommendationget
Interests
- Get all interestsget
- Get an interestget
Languages
- Get all languagesget
Messages
Message templates
- Get all message templatesget
- Get a message templateget
One Time Password
- Send a one-time password to a communication channel.post
- Verify a one-time passwordpost
Orders
Partners
Partner properties
- Get all partner propertiesget
- Get a partner propertyget
Payment types
- Get all payment typesget
- Detail of an payment typeget
Points
Point history
- Get point transaction historyget
Point reservation
Point types
- Get all point typesget
- Get a point typeget
Products
Product brands
Product groups
Product properties
- Get all product propertiesget
- Get a product propertyget
Product recommendation engine
Product reservation prices
Product reservations
Product reservation external list types
- Get all product reservation external list typesget
- Detail of a product reservation external list typeget
Product reservation sources
- Get all product reservation sourcesget
- Detail of a product reservation sourceget
Purchase properties
- Get all purchase properties listget
- Get a purchase propertyget
Purchases
Purchase item properties
- Get all purchase item properties listget
- Get a purchase item propertyget
Purchase item types
- Get all purchase item typesget
Purchase types
- Get all purchase typesget
Reservable products
Rewards
Reward properties
- Get all reward propertiesget
- Get a reward propertyget
Reward types
- Get all reward typesget
- Get a reward typeget
Segments
Stamper
Statuses
- Get all statusesget
- Get a statusget
Store properties
- Get all store propertiesget
- Get a store propertyget
Stores
Store groups
- Get all store groupsget
- Get a store groupget
Tasks
Task properties
- Get all task propertiesget
- Get a task propertyget
Tests
- Connection testget
Tokens
Users
User roles
- Get all user rolesget
- Get information about a user roleget
Vouchers
Voucher properties
- Get all voucher propertiesget
- Get a voucher propertyget
Wallet

Get all booking statuses

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/booking-statuses

Get information about all booking statuses.

URL Expired

The URL for this request expired after 30 days.

Query Params

count

integer

≥ 1

Defaults to 100

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.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

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.

sort_direction

string

Direction of sorting the response list.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

booking_statuses

array of objects

Collection of booking statuses.

booking_statuses

object

booking_status_id

string

The unique ID of the booking status.

name

string

required

Name of the booking status in language from request header.

created_at

string

Date and time of booking status creation. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the booking status.
Possible values are: 0 - blocked / 1 - active

1

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

total_items

integer

The number of all found booking statuses.

Response body

object

error

object

type

string

required

exception

string

required

Content of the exception.

title

string

required

The title of the error.

detail

string

required

The details of the error message.

error_data

object

Data in case of an exception.

Response body

object

error

object

type

string

required

exception

string

required

Content of the exception.

title

string

required

The title of the error.

detail

string

required

The details of the error message.

error_data

object

Data in case of an exception.

Has additional fields

Response body

object

error

object

type

string

title

string

detail

string

error_data

object

Data in case of an exception.

Response body

object

error

object

type

string

required

exception

string

required

Content of the exception.

title

string

required

The title of the error.

detail

string

required

The details of the error message.

error_data

object

Data in case of an exception.

Response body

object

error

object

type

string

required

exception

string

required

Content of the exception.

title

string

required

The title of the error.

detail

string

required

The details of the error message.

error_data

object

Data in case of an exception.

429

Too many requests - more than the resource limit.

Response body

object

error

object

type

string

required

exception

string

required

Content of the exception.

title

string

required

The title of the error.

detail

string

required

The details of the error message.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated over 1 year ago

Get information about booking busy times

Get a booking status

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/booking-statuses?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
14
 
1
{
2
  "data": {
3
    "booking_statuses": [
4
      {
5
        "booking_status_id": "8bf3397ab62d3ffd876fc9ae16",
6
        "name": "Pending",
7
        "created_at": "2022-09-14 07:39:08.99493",
8
        "state": 1,
9
        "last_change": "2022-09-14 07:39:08.99493"
10
      }
11
    ],
12
    "total_items": 1
13
  }
14
}

Updated over 1 year ago

Get information about booking busy times

Get a booking status

Did this page help you?

CRM CareCloud REST API
Getting Started With CareCloud API
Authentication
Tools
FAQ

REST API Reference
Booking tickets
Get a collection time slots depends on booking ticketget
Get a booking ticketget
Get all booking ticketsget
Bookings
Get information about booking busy timespost
Delete a bookingdelete
Update a bookingput
Get a bookingget
Create a new bookingpost
Get all bookingsget
Booking statuses
Get a booking statusget
Get all booking statusesget
Booking ticket properties
Get a booking ticket propertyget
Get all booking ticket propertiesget
Campaigns
Detail of a specific campaignget
Create a campaignpost
Collection of campaignsget
Campaign products
Add a store to the campaign productpost
Get a campaign product store recordsget
Detail of a specific campaign productget
Create a campaign productpost
Collection of campaign productsget
Cards
Create a batch of cardspost
Validate ISIC cardpost
Get a PassMachine digital cardpost
Generate virtual card filepost
Validate free cardpost
Assign free cardpost
Update a cardput
Get a cardget
Create a cardpost
Get all cardsget
Card types
Get a collection of cardsget
Update a card typeput
Get a card typeget
Create a new card typepost
Get information about all card typesget
Charged entrances
Get a customer entrances usage statsget
Get entrances overviewget
Update an entranceput
Get an entranceget
Get all entrancesget
Communication channels
Detail of a communication channelget
Get all communication channelsget
Consents
Detail of an consentget
Get all consentsget
Countries
Get all countriesget
Credits
Transfer creditspost
Deposit of creditspost
Credit reductionpost
Get a collection of purchasesget
Get a credit recordget
Get all credit recordsget
Credit history
Get credit transaction historyget
Credit types
Get a credit typeget
Get all credit typesget
Currencies
Detail of a currencyget
Get all currenciesget
Customers
Delete a partner record from an accountdelete
Add a partner to the customerpost
Get information about all customer partnersget
Delete the customer relationdelete
Detail of a relation between customersget
Create the customer relationpost
Get information about all related customersget
Get information about all customer eventsget
Update an additional customer addressput
Get an additional customer addressget
Create an additional customer addresspost
Get all additional customer addressesget
Delete an interest record on an accountdelete
Update an interest record on an accountput
Add an interest record to a customerpost
Get a collection of interest recordsget
Create a batch of property records for a customerpost
Delete a property of a customerdelete
Update a property of a customerput
Add a property to a customerpost
Get a collection of propertiesget
Add a customer source record to a customerpost
Get customer source recordsget
Get a collection of Hint recordsget
Get a collection of status recordsget
Get a collection of segment recordsget
Get all customer cardsget
Recommend the best rewards for the customerget
Get all customer rewardsget
Get all customer vouchersget
Get all customer point recordsget
Get all customer purchasesget
Update a customerput
Get information about a customerget
Get all customersget
Create a new customerpost
Customer engagement
Get a customer engagement setupget
Get all customer engagement setupsget
Customers actions
Check ability to register a customerpost
Cancel the customer's push notifications subscription from all devices if push token not specified.post
Set the customer's push notificationspost
Sign up for newsletterspost
Set a new customer statuspost
Set one or multiple partners to the customerpost
Upload the customer profile photopost
Search customersget
Validation of the customer datapost
Verify auth tokenpost
Social network credentials verificationpost
Customer's credentials verificationpost
Customer address types
Detail of a customer address typeget
Get all customer address typesget
Customer external applications
Detail of a customer external applicationget
Get all customer external applicationsget
Customer properties
Get a customer propertyget
Get all customer propertiesget
Customer relation types
Detail of a customer relation typeget
Get all customer relation typesget
Customer sources
Detail of a customer sourceget
Get customer sourcesget
Customer source records
Get customer source recordsget
Customer types
Detail of a customer typeget
Get all customer typesget
Events
Get a collection of event properties recordsget
Get an eventget
Create a new eventpost
Get information about all eventsget
Event groups
Get an event groupget
Get all event groupsget
Event properties
Get an event propertyget
Get all event propertiesget
Event types
Get a collection of event type propertiesget
Get an event typeget
Get all event typesget
Hints
Get a recommendationget
Get all recommendationsget
Interests
Get an interestget
Get all interestsget
Languages
Get all languagesget
Messages
Send messagepost
Get a message detailget
Get a messageget
Get all messagesget
Message templates
Get a message templateget
Get all message templatesget
One Time Password
Verify a one-time passwordpost
Send a one-time password to a communication channel.post
Orders
Get an orderget
Create an orderpost
Get all ordersget
Partners
Get a collection of property recordsget
Get a partnerget
Get all partnersget
Partner properties
Get a partner propertyget
Get all partner propertiesget
Payment types
Detail of an payment typeget
Get all payment typesget
Points
Synchronize customer's pointspost
Transfer pointspost
Assign of pointspost
Points redemptionpost
Get a collection of purchasesget
Get a point recordget
Get all point recordsget
Point history
Get point transaction historyget
Point reservation
Free points from reservationpost
Create point reservationpost
Get a point reservationget
Get all point reservationsget
Point types
Get a point typeget
Get all point typesget
Products
Get all tags for resource productsget
Create a batch of productspost
Detail of a productget
Collection of available productsget
Product brands
Create a batch of product brandspost
Get a product brandget
Get all product brandget
Product groups
Create a batch of product groups. If a group already exists, an update is applied.post
Get a product groupget
Get all product groupsget
Product properties
Get a product propertyget
Get all product propertiesget
Product recommendation engine
Create a batch of the third party recommendationspost
Get the best recommendation for shopping cartpost
Order products for the best recommendation for a shopping cartpost
Get the best recommendation with elimination for shopping cartpost
Get the best recommendationpost
Order products for the best recommendation.post
Get the best recommendation with an eliminationpost
Product reservation prices
Delete a batch of product reservation pricesdelete
Create a batch of product reservation pricespost
Get a detail of product reservation priceget
Get all product reservation pricesget
Product reservations
Set one or multiple external reservation codes of different types to the product reservationpost
Change reservation statepost
Cancel reservationpost
Get a product-reservationget
Create a reservationpost
Get all product reservationsget
Product reservation external list types
Detail of a product reservation external list typeget
Get all product reservation external list typesget
Product reservation sources
Detail of a product reservation sourceget
Get all product reservation sourcesget
Purchase properties
Get a purchase propertyget
Get all purchase properties listget
Purchases
Assign customerpost
Send purchasepost
Accept paymentpost
Best rewards for purchasepost
Return payment summaryget
Get point records tied to a purchaseget
Get vouchers tied to a purchaseget
Get purchase items tied to a purchaseget
Update a purchaseput
Get a purchaseget
Get all purchasesget
Purchase item properties
Get a purchase item propertyget
Get all purchase item properties listget
Purchase item types
Get all purchase item typesget
Purchase types
Get all purchase typesget
Reservable products
Search reservable productspost
Get a reservable productget
Get all reservable productsget
Rewards
Create a Simple rewardpost
Recommend the best rewards for the customerget
Set all products that reward can be applied topost
Create a new voucherpost
Get all tags for resource rewardsget
Get all storesget
Get product brands tied to a rewardget
Get product groups tied to a rewardget
Get products tied to a rewardget
Get vouchers tied to a rewardget
Get a rewardget
Get all rewardsget
Reward properties
Get a reward propertyget
Get all reward propertiesget
Reward types
Get a reward typeget
Get all reward typesget
Segments
Get a segment groupget
Get all segment groupsget
Remove customer from a segmentpost
Add customer to a segmentpost
Get a collection of segment recordsget
Get a segmentget
Create an empty segmentpost
Get all segmentsget
Stamper
Get a stampget
Get all stamper stampsget
Get a stamper cardget
Get all stamper cardsget
Get a stamper campaignget
Get all stamper campaignsget
Statuses
Get a statusget
Get all statusesget
Store properties
Get a store propertyget
Get all store propertiesget
Stores
Delete a property record of the storedelete
Update a property record of the storeput
Get a collection of store group recordsget
Add a property to a storepost
Get a collection of propertiesget
Update a storeput
Get a storeget
Create a storepost
Get all storesget
Store groups
Get a store groupget
Get all store groupsget
Tasks
Get a collection of task properties recordsget
Get a task stateget
Get all task statesget
Get a task typeget
Get all task typesget
Delete a task assignee from the taskdelete
Get a task assigneeget
Create a task assigneepost
Get all task assigneesget
Get a task commentget
Create a task commentpost
Get all task commentsget
Update a taskput
Get a taskget
Create a taskpost
Get all tasksget
Task properties
Get a task propertyget
Get all task propertiesget
Tests
Connection testget
Tokens
Login to the application for test customerpost
Get authentication tokenget
Send the message for the setup of a new customer's passwordpost
Login via social networkpost
Login via authentication tokenpost
Logout from the applicationpost
Login to the applicationpost
Edit a push tokenput
Create a tokenpost
Users
User logoutpost
User SSO loginpost
User loginpost
Verify user auth tokenpost
Get information about a userget
Get all usersget
User roles
Get information about a user roleget
Get all user rolesget
Vouchers
Create a batch of vouchers.post
Application of a voucherpost
Get a collection of voucher properties recordsget
Delete a voucherdelete
Update a voucherput
Get a voucherget
Get all vouchersget
Voucher properties
Get a voucher propertyget
Get all voucher propertiesget
Wallet
Get credits expiration overviewget
Get points expiration overviewget
Get credits overviewget
Get points overviewget
Get sales turnoverget

CRM CareCloud REST API
Getting Started With CareCloud API
Authentication
Tools
FAQ

REST API Reference
Booking tickets
Get a collection time slots depends on booking ticketget
Get a booking ticketget
Get all booking ticketsget
Bookings
Get information about booking busy timespost
Delete a bookingdelete
Update a bookingput
Get a bookingget
Create a new bookingpost
Get all bookingsget
Booking statuses
Get a booking statusget
Get all booking statusesget
Booking ticket properties
Get a booking ticket propertyget
Get all booking ticket propertiesget
Campaigns
Detail of a specific campaignget
Create a campaignpost
Collection of campaignsget
Campaign products
Add a store to the campaign productpost
Get a campaign product store recordsget
Detail of a specific campaign productget
Create a campaign productpost
Collection of campaign productsget
Cards
Create a batch of cardspost
Validate ISIC cardpost
Get a PassMachine digital cardpost
Generate virtual card filepost
Validate free cardpost
Assign free cardpost
Update a cardput
Get a cardget
Create a cardpost
Get all cardsget
Card types
Get a collection of cardsget
Update a card typeput
Get a card typeget
Create a new card typepost
Get information about all card typesget
Charged entrances
Get a customer entrances usage statsget
Get entrances overviewget
Update an entranceput
Get an entranceget
Get all entrancesget
Communication channels
Detail of a communication channelget
Get all communication channelsget
Consents
Detail of an consentget
Get all consentsget
Countries
Get all countriesget
Credits
Transfer creditspost
Deposit of creditspost
Credit reductionpost
Get a collection of purchasesget
Get a credit recordget
Get all credit recordsget
Credit history
Get credit transaction historyget
Credit types
Get a credit typeget
Get all credit typesget
Currencies
Detail of a currencyget
Get all currenciesget
Customers
Delete a partner record from an accountdelete
Add a partner to the customerpost
Get information about all customer partnersget
Delete the customer relationdelete
Detail of a relation between customersget
Create the customer relationpost
Get information about all related customersget
Get information about all customer eventsget
Update an additional customer addressput
Get an additional customer addressget
Create an additional customer addresspost
Get all additional customer addressesget
Delete an interest record on an accountdelete
Update an interest record on an accountput
Add an interest record to a customerpost
Get a collection of interest recordsget
Create a batch of property records for a customerpost
Delete a property of a customerdelete
Update a property of a customerput
Add a property to a customerpost
Get a collection of propertiesget
Add a customer source record to a customerpost
Get customer source recordsget
Get a collection of Hint recordsget
Get a collection of status recordsget
Get a collection of segment recordsget
Get all customer cardsget
Recommend the best rewards for the customerget
Get all customer rewardsget
Get all customer vouchersget
Get all customer point recordsget
Get all customer purchasesget
Update a customerput
Get information about a customerget
Get all customersget
Create a new customerpost
Customer engagement
Get a customer engagement setupget
Get all customer engagement setupsget
Customers actions
Check ability to register a customerpost
Cancel the customer's push notifications subscription from all devices if push token not specified.post
Set the customer's push notificationspost
Sign up for newsletterspost
Set a new customer statuspost
Set one or multiple partners to the customerpost
Upload the customer profile photopost
Search customersget
Validation of the customer datapost
Verify auth tokenpost
Social network credentials verificationpost
Customer's credentials verificationpost
Customer address types
Detail of a customer address typeget
Get all customer address typesget
Customer external applications
Detail of a customer external applicationget
Get all customer external applicationsget
Customer properties
Get a customer propertyget
Get all customer propertiesget
Customer relation types
Detail of a customer relation typeget
Get all customer relation typesget
Customer sources
Detail of a customer sourceget
Get customer sourcesget
Customer source records
Get customer source recordsget
Customer types
Detail of a customer typeget
Get all customer typesget
Events
Get a collection of event properties recordsget
Get an eventget
Create a new eventpost
Get information about all eventsget
Event groups
Get an event groupget
Get all event groupsget
Event properties
Get an event propertyget
Get all event propertiesget
Event types
Get a collection of event type propertiesget
Get an event typeget
Get all event typesget
Hints
Get a recommendationget
Get all recommendationsget
Interests
Get an interestget
Get all interestsget
Languages
Get all languagesget
Messages
Send messagepost
Get a message detailget
Get a messageget
Get all messagesget
Message templates
Get a message templateget
Get all message templatesget
One Time Password
Verify a one-time passwordpost
Send a one-time password to a communication channel.post
Orders
Get an orderget
Create an orderpost
Get all ordersget
Partners
Get a collection of property recordsget
Get a partnerget
Get all partnersget
Partner properties
Get a partner propertyget
Get all partner propertiesget
Payment types
Detail of an payment typeget
Get all payment typesget
Points
Synchronize customer's pointspost
Transfer pointspost
Assign of pointspost
Points redemptionpost
Get a collection of purchasesget
Get a point recordget
Get all point recordsget
Point history
Get point transaction historyget
Point reservation
Free points from reservationpost
Create point reservationpost
Get a point reservationget
Get all point reservationsget
Point types
Get a point typeget
Get all point typesget
Products
Get all tags for resource productsget
Create a batch of productspost
Detail of a productget
Collection of available productsget
Product brands
Create a batch of product brandspost
Get a product brandget
Get all product brandget
Product groups
Create a batch of product groups. If a group already exists, an update is applied.post
Get a product groupget
Get all product groupsget
Product properties
Get a product propertyget
Get all product propertiesget
Product recommendation engine
Create a batch of the third party recommendationspost
Get the best recommendation for shopping cartpost
Order products for the best recommendation for a shopping cartpost
Get the best recommendation with elimination for shopping cartpost
Get the best recommendationpost
Order products for the best recommendation.post
Get the best recommendation with an eliminationpost
Product reservation prices
Delete a batch of product reservation pricesdelete
Create a batch of product reservation pricespost
Get a detail of product reservation priceget
Get all product reservation pricesget
Product reservations
Set one or multiple external reservation codes of different types to the product reservationpost
Change reservation statepost
Cancel reservationpost
Get a product-reservationget
Create a reservationpost
Get all product reservationsget
Product reservation external list types
Detail of a product reservation external list typeget
Get all product reservation external list typesget
Product reservation sources
Detail of a product reservation sourceget
Get all product reservation sourcesget
Purchase properties
Get a purchase propertyget
Get all purchase properties listget
Purchases
Assign customerpost
Send purchasepost
Accept paymentpost
Best rewards for purchasepost
Return payment summaryget
Get point records tied to a purchaseget
Get vouchers tied to a purchaseget
Get purchase items tied to a purchaseget
Update a purchaseput
Get a purchaseget
Get all purchasesget
Purchase item properties
Get a purchase item propertyget
Get all purchase item properties listget
Purchase item types
Get all purchase item typesget
Purchase types
Get all purchase typesget
Reservable products
Search reservable productspost
Get a reservable productget
Get all reservable productsget
Rewards
Create a Simple rewardpost
Recommend the best rewards for the customerget
Set all products that reward can be applied topost
Create a new voucherpost
Get all tags for resource rewardsget
Get all storesget
Get product brands tied to a rewardget
Get product groups tied to a rewardget
Get products tied to a rewardget
Get vouchers tied to a rewardget
Get a rewardget
Get all rewardsget
Reward properties
Get a reward propertyget
Get all reward propertiesget
Reward types
Get a reward typeget
Get all reward typesget
Segments
Get a segment groupget
Get all segment groupsget
Remove customer from a segmentpost
Add customer to a segmentpost
Get a collection of segment recordsget
Get a segmentget
Create an empty segmentpost
Get all segmentsget
Stamper
Get a stampget
Get all stamper stampsget
Get a stamper cardget
Get all stamper cardsget
Get a stamper campaignget
Get all stamper campaignsget
Statuses
Get a statusget
Get all statusesget
Store properties
Get a store propertyget
Get all store propertiesget
Stores
Delete a property record of the storedelete
Update a property record of the storeput
Get a collection of store group recordsget
Add a property to a storepost
Get a collection of propertiesget
Update a storeput
Get a storeget
Create a storepost
Get all storesget
Store groups
Get a store groupget
Get all store groupsget
Tasks
Get a collection of task properties recordsget
Get a task stateget
Get all task statesget
Get a task typeget
Get all task typesget
Delete a task assignee from the taskdelete
Get a task assigneeget
Create a task assigneepost
Get all task assigneesget
Get a task commentget
Create a task commentpost
Get all task commentsget
Update a taskput
Get a taskget
Create a taskpost
Get all tasksget
Task properties
Get a task propertyget
Get all task propertiesget
Tests
Connection testget
Tokens
Login to the application for test customerpost
Get authentication tokenget
Send the message for the setup of a new customer's passwordpost
Login via social networkpost
Login via authentication tokenpost
Logout from the applicationpost
Login to the applicationpost
Edit a push tokenput
Create a tokenpost
Users
User logoutpost
User SSO loginpost
User loginpost
Verify user auth tokenpost
Get information about a userget
Get all usersget
User roles
Get information about a user roleget
Get all user rolesget
Vouchers
Create a batch of vouchers.post
Application of a voucherpost
Get a collection of voucher properties recordsget
Delete a voucherdelete
Update a voucherput
Get a voucherget
Get all vouchersget
Voucher properties
Get a voucher propertyget
Get all voucher propertiesget
Wallet
Get credits expiration overviewget
Get points expiration overviewget
Get credits overviewget
Get points overviewget
Get sales turnoverget

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.