{"id":5186,"date":"2022-07-21T13:15:22","date_gmt":"2022-07-21T11:15:22","guid":{"rendered":"https:\/\/www.crmcarecloud.com\/?page_id=5186"},"modified":"2025-06-04T15:28:30","modified_gmt":"2025-06-04T13:28:30","slug":"integrate-with-pos-system","status":"publish","type":"page","link":"https:\/\/www.crmcarecloud.com\/it\/integrate-with-pos-system\/","title":{"rendered":"Integrate with POS system"},"content":{"rendered":"\n

\n\t\tIntegrate with your POS or Cash Desk App\n\t<\/h1>\n\t

Use CareCloud platform REST API to integrate with POS system or Cash Desk application<\/h1>\n\n\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tDiscover more\n\t\t\t\t\t\t\t<\/a>\n\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tGet in Touch\n\t\t\t\t\t\t\t<\/a>\n

\n\t\tSetup and integration\n\t<\/h2>\n\t

Here, you will find the complete developer’s Guide to CareCloud platform REST API integration with your application. Please read and learn more about the integration process and make the first steps easier and simpler with Quickstart. You can learn how to use our REST API and create the first API calls. This guide enables easy authentication and safe calling with full respect to your data security. You find here the description of API parameters and versioning, URL structure, error codes, and HTTP verbs.<\/p>\n

Enjoy the CareCloud platform REST API Guide!<\/p>\n\t\t\t\t\n\t\t\t\t\"use_case\"\n\t\t\t\t<\/a>\n

\n\t\tUse Cases\n\t<\/h4>\n\t\t\t

Get inspired by the best practices<\/p>\t\t\n\t\t\t

Make your work easier<\/p>\t\t\n\t\t\t

Save time and money<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n\t\t\t\t\n\t\t\t\t\"quickstart-small\"\n\t\t\t\t<\/a>\n

\n\t\tQuickstart\n\t<\/h4>\n\t\t\t

Are you new here? Launch with Quickstart!<\/p>\t\t\n\t\t\t

Learn how to use REST API<\/p>\t\t\n\t\t\t

Your first API call<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n\t\t\t\t\n\t\t\t\t\"restapi-small\"\n\t\t\t\t<\/a>\n

\n\t\tAuthentication\n\t<\/h4>\n\t\t\t

Learn how to authenticate to REST API<\/p>\t\t\n\t\t\t

How to get and use bearer token?<\/p>\t\t\n\t\t\t

Use REST API safe and sound<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n\t\t\t\t\n\t\t\t\t\"api-tools6\"\n\t\t\t\t<\/a>\n

\n\t\tAPI Tools\n\t<\/h4>\n\t\t\t

Download “API Collection” and start using Postman<\/p>\t\t\n\t\t\t

Integrate with REST API SDK easily<\/p>\t\t\n\t\t\t

Use the basic building blocks of the PHP client API<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n\t\t\t\t\n\t\t\t\t\"webhooks5\"\n\t\t\t\t<\/a>\n

\n\t\tWebhooks\n\t<\/h4>\n\t\t\t

A quick guide on how to use webhooks<\/p>\t\t\n\t\t\t

Receive notification about data changes and actions<\/p>\t\t\n\t\t\t

Use webhooks in the Marketing Automation app<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n\t\t\t\t\n\t\t\t\t\"online-checkout1\"\n\t\t\t\t<\/a>\n

\n\t\tOnline Checkout\n\t<\/h4>\n\t\t\t

Connect CareCloud platform and POS or e-shop online!<\/p>\t\t\n\t\t\t

Apply all benefits at checkout<\/p>\t\t\n\t\t\t

Take advantage of central benefits administration<\/p>\t\t\n\t

Learn more \u2192<\/a><\/p>\n

\n\t\tAPI tools set\n\t<\/h2>\n\t

You will find here the easy way how to start using CareCloud API. Just download the collection and import it into your Postman installation. In a matter of minutes, you can do API calls on your own. Moreover, you learn here how to use CareCloud API SDK, the convenient wrapper around CareCloud PHP Client, starting with installing the package, creating your API client, and accessing all the API endpoints from the client object.<\/p>\n

Here, you will find the API client in PHP with a quick integration base to customize your implementation. Open API 3.0 documentation helps you generate your API client and provides the Open API tools set.<\/p>\n

 <\/p>\n

\n\t\tPostman Collection\n\t<\/h4>\n\t\t\t

Install your Postman or access it online<\/p>\t\t\n\t\t\t

Download CareCloud API collection<\/p>\t\t\n\t\t\t

See the first API calls easy guide<\/p>\t\t\n\t

GitHub \u2192<\/a><\/p>\n

\n\t\tSDK in PHP\n\t<\/h4>\n\t\t\t

Easy integration<\/p>\t\t\n\t\t\t

REST API SDK with full list of resources<\/p>\t\t\n\t\t\t

Best practice implemented<\/p>\t\t\n\t

GitHub \u2192<\/a><\/p>\n

\n\t\tPHP API client\n\t<\/h4>\n\t\t\t

Quick integration base<\/p>\t\t\n\t\t\t

Customize your implementation<\/p>\t\t\n\t\t\t

Access all API endpoints<\/p>\t\t\n\t

GitHub \u2192<\/a><\/p>\n

\n\t\tUse cases\n\t<\/h2>\n\t

You will find here detailed descriptions of specific use cases for your needs. Get inspired by describing the best practices for integrating CareCloud platform REST API with your application and make your work easier. Using the related use cases will save you time and money!<\/p>\n

\n\t\tCustomer account operations\n\t<\/h3>\n\t\t\t\t\tCustomer sign-up<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t
    \n
  1. To successfully sign up for a customer, you have to collect all the customer information. That might require using other CareCloud API resources. This process must be done before creating a customer account by [POST] \/customers<\/a>.<\/li>\n
  2. We will show you how to use resource stores, customer sources or customer properties for the use case. To get all options for store_id, you should call [GET] \/stores<\/a>. You will get a response containing the list of stores and their unique IDs.<\/li>\n
  3. Use the values in the sign-up form to let the customer pick the correct one. Store it for later use of [POST] \/customers<\/a>.<\/li>\n
  4. Now, you need to know what kind of customer source will be set to the customer. The customer source identifies the place\/system\/business where your customer came from. In short, it is his origin.
    \nFor example, one customer source could be an e-shop (the customer was registered through an e-shop), and another could be brick-and-mortar, so you know he was registered in a store.
    \nEvery customer source record of the customer can have an external ID. The ID represents the identification of the customer in that system. Later, you can search customers by this ID to synchronize between systems.
    \nYou can call     [GET]\/customer-sources<\/a> to get a list of customer sources. Pick the one that fits the source and add an ID to the customer creation request in the following steps.<\/li>\n
  5. The customer’s properties could be set directly in [POST] \/customers<\/a> or afterward if necessary with endpoint [POST] \/customers\/{customer_id}\/property-records<\/a>. Lists of all properties are available at [GET] \/customer-properties<\/a>.<\/li>\n
  6. Use the method [POST] \/customers<\/a> to create a customer account. Set store_id as the registration branch of a customer account and customer_source_id as a source of the customer registration.<\/li>\n
  7. Repeat POST method calls if you need to set other resources to the customer account.<\/li>\n<\/ol>\n\t\t\t\t\tCustomer credentials verification<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

    The use case can apply to e-shop or production system integration, where you need access to all customer’s data and request verification from the customer through the login screen.<\/p>\n

    We recommended customer verification the following way:<\/p>\n

      \n
    1. Display a sign-in form to the customer.\n
        \n
      1. You can display a choice of customer identifier. CareCloud API currently supports options for email and customer’s card number.<\/li>\n
      2. Alternatively, you can let the customer fill in his identifier without choosing a type and then decide on your side(form processing) if he filled in an email or a customer’s card. You can use regular expressions to make a decision.<\/li>\n<\/ol>\n<\/li>\n
      3. The customer fills in his credentials and sends the form.<\/li>\n
      4. The application validates inputs (email format, customer’s card format, password format) and informs the customer with an appropriate message in case of invalid input.<\/li>\n
      5. If the customer enters all inputs correctly, the application will validate credentials against CareCloud API with the POST \/customers\/actions\/verify-credentials<\/a> call.<\/li>\n
      6. Suppose CareClould API verifies a customer as a response. In that case, you will get a customer ID from CareCloud API, which you can use for receiving other customer information like purchases, reservations, loyalty information, or customer data.\u00a0<\/li>\n
      7. If verification is unsuccessful, you will be informed by an appropriate message from CareCloud API. Depending on the message, you can display your message to the customer in your application.<\/li>\n
      8. The essential information is this use case was designed only for verification, so it doesn’t mean the customer was logged in to CareCloud. If you want to log in customer, you need to keep this information on your side.<\/li>\n<\/ol>\n\t\t\t\t\tSearch customer and get customer personal data<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

        The use case can apply to e-shop or production system integration, where you need access to data of multiple customers or search for a customer by his identifiers (email, phone number, or name).<\/p>\n

        We recommended searching customer’s data following way:<\/p>\n

          \n
        1. If you need to search for data from one or multiple customers, use the resource GET\u00a0\/customers<\/a>. To find one or more customers, you need to know their email, phone number, first name, last name, or birthdate.<\/li>\n
        2. Add them into query parameters. The more parameters you fill in, the better and more exact the result will be. In this method, you can get multiple results if the parameter’s value is general, like “name=John”.<\/li>\n
        3. The response contains customer information, including ID, personal data, or consent, that you can process as needed.<\/li>\n
        4. If you want to search for one specific customer and expect only one result from searching, please use the action method GET\u00a0\/customers\/actions\/search-customers<\/a>.<\/li>\n
        5. Use strict mode in query parameters. In this mode, you must know the first name, last name, birth date, and customer’s card number.<\/li>\n
        6. If CareCloud has this customer, you are going to get an ID.<\/li>\n
        7. To access the customer’s data, you need to do one extra CareCloud API call where you will add the customer ID from the previous call as a path parameter GET\u00a0\/customers\/{customer_id}<\/a>.<\/li>\n
        8. Every resource or method from previous points returns structures with the customer ID. This ID can be used for other resources as a path parameter to limit results tied to the customer. For example, customer vouchers GET\u00a0\/customers\/{customer_id}\/vouchers<\/a> or customer card GET\u00a0\/customers\/{customer_id}\/cards<\/a> or customer properties GET\u00a0\/customers\/{customer_id}\/property-records<\/a> and other you can find in API reference guide: https:\/\/developers.crmcarecloud.com\/#tag\/Customers<\/a><\/li>\n<\/ol>\n\t\t\t\t\tFind a customer by production system identification<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

          The use case is applied if you need to find a customer with external(other than CareCloud API) identification. More information is below:<\/p>\n

            \n
          1. To find a customer with an ID from your system, creating a customer with a customer source record containing that ID is crucial. You can do that at https:\/\/carecloud.readme.io\/reference\/postcustomer<\/a>. See the customer source parameter.<\/li>\n
          2. You can also add a customer source to the existing customer. To do that, you can use https:\/\/carecloud.readme.io\/reference\/postsubcustomersource<\/a>.<\/li>\n
          3. If you are sure that all the customers have identification from your system, you can find the customer source record with an external ID in the endpoint:\u00a0https:\/\/carecloud.readme.io\/reference\/getcustomersourcerecords<\/a>.\u00a0Add an ID and identification of customer source from CareCloud API to request.<\/li>\n
          4. If the customer source record exists, you will receive a structure with the customer ID in the response.<\/li>\n
          5. You can use customer ID for the next API calls, for example, for customer’s data in endpoint https:\/\/carecloud.readme.io\/reference\/getcustomer<\/a> or update of the customer in endpoint https:\/\/carecloud.readme.io\/reference\/putcustomer<\/a>.<\/li>\n<\/ol>\n\t\t\t\t\tSynchronize customers between production systems and CareCloud<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

            The use case describes synchronizing customer data between CareCloud and other systems.<\/p>\n

              \n
            1. Try to find the customer in CareCloud with a customer ID from your system(e-shop, POS, ERP, accounting systems, and others). You can find the customer source record with that ID in the endpoint https:\/\/carecloud.readme.io\/reference\/getcustomersourcerecords<\/a>. Add an ID and identification of customer source from CareCloud API to request.<\/li>\n
            2. If the customer source record exists, you will receive a structure with the customer ID in the response. Now you can get existing customer information and synchronize it in your system https:\/\/carecloud.readme.io\/reference\/getcustomer<\/a>. Or update an existing customer in CareCloud https:\/\/carecloud.readme.io\/reference\/putcustomer<\/a>.<\/li>\n
            3. If the customer source does not exist, you must create that customer https:\/\/carecloud.readme.io\/reference\/postcustomer<\/a> with appropriate identification and customer source.<\/li>\n
            4. This use case will work only if you synchronize an external identification from the start. Otherwise, duplications can occur.<\/li>\n<\/ol>\n\t\t\t\t\tCustomer personal data update<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

              Updating the customer is a critical process, and it is crucial to do it right so you keep all the customer’s data. For an update, please follow this use case:<\/p>\n

                \n
              1. For an update, you need to know your customer first. That means you have to have his ID. The ID could be reached in multiple ways, which you can find in other use cases. Information on how to get all the customer data is available in use cases: Search customers and get customer personal data<\/a> or Find a customer by production system identification<\/a>. Customer ID is available after Customer credentials verification<\/a>. But then make sure you get complete customer data with GET \/customers\/{customer_id}<\/a> to be able to modify them in the update call.<\/li>\n
              2. Now you have everything you need and you can update the customer’s data with endpoint PUT \/customers\/{customer_id}<\/a>. This endpoint has to contain all the customer information. All parameters that won’t be set in the request will be lost because of the principle of the HTTP PUT verb<\/a>.<\/li>\n
              3. The successful update is represented by 204 HTTP code. In case of an error, the error message explains the issue.<\/li>\n
              4. If you need to update a customer’s properties, please use endpoint PUT \/customers\/{customer_id}\/property-records\/{property_record_id}<\/a>. There you can modify existing properties<\/li>\n<\/ol>\n\t\t\t\t\tAssign a card to the existing customer<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                This use case describes the process of assigning free cards to the existing customer. In this case, the customer holds the card and knows the number of the card. It covers only cards that exist in the database already and are ready to be used.<\/p>\n

                  \n
                1. Find the card that customers holds by the card number. To do that, search by query parameter `card_number` in GET \/cards<\/a>.<\/li>\n
                2. If you got a successful result, that means the card you are looking for exists in the database. The next step is to check the card’s parameters to confirm it is free to use. You need to check the parameter `customer_id` (should have the value `null`) to make sure the card is not assigned to another customer.<\/li>\n
                3. Next step is to add a customer identification to the card. With the following API call from resource PUT \/cards<\/a>. Set the parameter `customer_id` with the customer id. Other parameters stay unchanged.<\/li>\n
                4. After the successful API call, the card has been assigned to the customer, and it’s ready to be used. In case of any error, please follow the error message to find the solution.<\/li>\n<\/ol>\n\t\t\t\t\tForgotten password<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                  The use case can apply to e-shop or production system integration, where a customer needs to change his password in CareCloud.<\/p>\n

                  We recommended changing the customer’s password in the following way:<\/p>\n

                   <\/p>\n

                    \n
                  1. The customer can request a change if he doesn’t remember his password.<\/li>\n
                  2. The customer fills in the email address to the application form. The application validates the email address structure.<\/li>\n
                  3. After the email address validation, the application checks its existence in CareCloud with an API call GET \/customers<\/a>. If the email address is present, the application sends an email with the link to change the password.<\/li>\n
                  4. The customer opens an email and clicks on the link.<\/li>\n
                  5. The customer is forwarded to the application form for password change.<\/li>\n
                  6. The customer fills out the form with a new password, and the application validates the amount and type of the characters in the password(It must follow the CareCloud API restriction for the password PUT \/customers\/{customer_id}<\/a>).<\/li>\n
                  7. After successful validation, the application has to update a new password in the customer’s account. For that, the application has to do a CareCloud API call PUT \/customers\/{customer_id}<\/a> with the new password.<\/li>\n
                  8. If successful, the application shows a success message to the customer and forwards him to the login form.<\/li>\n<\/ol>\n

                     <\/p>\n

                    \"\"<\/p>\n

                    \n\t\tSending purchases\n\t<\/h3>\n\t\t\t\t\tSend order\/purchase<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                    The use case describes when the POS, e-shop, or other system wants to send a paid purchase\/order. All benefits and discounts were applied (or not), and the system needs to send the purchase\/order to CareCloud. If this is the case you are dealing with, please follow:<\/p>\n

                      \n
                    1. Before the transaction, please ensure your system has synchronized products, product groups, and brands with CareCloud. Depending on your setup, synchronization could be necessary every time your products changes.<\/li>\n
                    2. To send the purchase, please use the following endpoint [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n
                    3. Ensure you set all necessary parameters; the values match current purchase values; lower the price depending on points or credit use and use all benefits returned from CareCloud API in previous steps (if used). Also, make sure to set the payment_type parameter appropriately depending on the type of transaction.<\/li>\n
                    4. In case of success, the CareCloud API will return the purchase ID.<\/li>\n<\/ol>\n\t\t\t\t\tCancel order\/purchase<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                      If you need to cancel a purchase already sent to CareCloud, please follow these steps:<\/p>\n

                        \n
                      1. For cancelation of an order or a purchase, please use the endpoint for sending purchase: [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n
                      2. Almost all parameters have to be the same as in the original purchase. The only changes are in parameters `canceled`( `true` value if sending canceled purchase), `bill_id`(has to be a unique number), and `bill_number`(please use `bill_id` from the original purchase\/order ).<\/li>\n<\/ol>\n

                        \n\t\tCheck out process\n\t<\/h3>\n\t\t\t\t\tApplication of benefits in the shopping cart<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                        The use case can apply to an e-shop or POS where a customer wants to use his benefits (rewards, discounts, coupons, or vouchers). The use case describes only the part with the application of benefits. The other parts, such as sending the final purchase<\/a> or identification of the customer<\/a>, are part of checkout use cases, too.<\/p>\n

                        For the proper application of benefits, please follow this:<\/p>\n

                          \n
                        1. The e-shop sends the current content of the customer’s shopping cart and the unique voucher (if the customer added some) codes in the benefit_codes parameter through the end-point in [POST] \/purchases\/actions\/accept-payment<\/a>.\n
                            \n
                          1. Please remember to set all the necessary parameters as payment_type and others depending on the API reference guide.<\/li>\n
                          2. Different types of benefits could be applied depending on the chosen setup.<\/li>\n<\/ol>\n<\/li>\n
                          3. The CareCloud API returns all possible benefits, which you can apply to the customer’s shopping cart, the number of loyalty points gained from the potential purchase, or the total amount of the customer’s loyalty points after purchase. If the response doesn’t contain any rewards or discounts, our algorithm found no benefit that could be applied to the customer.<\/li>\n
                          4. The e-shop will keep all the information from the CareCloud API response.<\/li>\n
                          5. If the customer changes the shopping cart’s content, the e-shop must repeat the request to the endpoint [POST] \/purchases\/actions\/accept-payment<\/a> with updated shopping card data. The response to the call can be different this time because the customer might fulfill some of the defined conditions (amount of specific product or money threshold and others).<\/li>\n<\/ol>\n\t\t\t\t\tLoyalty points payment of e-shop order\/POS bill<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                            The use case is designed to allow you to use loyalty points for payments. The POS, e-shop, or another system can process point payments when a customer has available points in his account.<\/p>\n

                              \n
                            1. First, you need to know your customer. For that, you can find a customer by one of the identifiers (please check the use case Get customer personal data<\/a>) or search him (please check the use case Search customers and get customer personal data<\/a>).<\/li>\n
                            2. After identifying the customer, you need to check his point credit and see if he can process a payment or has enough points to cover the purchase. The resource wallet provides the number of available points here: [GET] \/wallet\/actions\/points-overview<\/a>.<\/li>\n
                            3. Depending on the number of points, POS can send the maximum amount of used points at the purchase with all purchase items in the endpoint [POST] \/purchases\/actions\/accept-payment<\/a>.<\/li>\n
                            4. CareCloud API will respond with a list of recommended benefits and discounts and information about the number of points that can be used with that transaction.<\/li>\n
                            5. The POS\/e-shop will keep that information about the number of purchase points and lower the final purchase price. Both information will be used in the following request to endpoint [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n
                            6. In the case where a customer wants to modify the shopping cart, you can change [POST] \/purchases\/actions\/accept-payment<\/a> request and repeat it multiple times before sending a final purchase [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n<\/ol>\n\t\t\t\t\tCredit payment of e-shop order\/POS bill<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                              The use case is designed to allow you to use credit payments. The POS, e-shop, or another system can process credit payments when a customer has available credits in his account.<\/p>\n

                                \n
                              1. First, you need to know your customer. For that, you can find a customer by one of the identifiers (please check the use case Get customer personal data<\/a>) or search him (please check the use case Search customers and get customer personal data<\/a>).<\/li>\n
                              2. After identifying the customer, you need to check his credit and see if he can process credit payments or has enough credit to cover the purchase. The resource wallet provides the number of available credits here: [GET] \/wallet\/actions\/credits-overview<\/a>.<\/li>\n
                              3. Depending on the available credit and the customer’s decision on how much credit he wants to use, POS can send the maximum amount of used credit at the purchase with all purchase items in the endpoint [POST] \/purchases\/actions\/accept-payment<\/a>. In case of credit payment, the appropriate payment_type has to be used ( type C; for more details, please see parameter `payment_type` in the documentation<\/a>).<\/li>\n
                              4. CareCloud API will respond with a list of recommended benefits and discounts and information about the credit that can be used with that transaction.<\/li>\n
                              5. The POS\/e-shop will keep that information about the used credit and lower the final purchase price. Both information will be used in the following request to endpoint [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n
                              6. In the case where a customer wants to modify the shopping cart, you can change [POST] \/purchases\/actions\/accept-payment<\/a> request and repeat it multiple times before sending a final purchase [POST] \/purchases\/actions\/send-purchase<\/a>.<\/li>\n<\/ol>\n\t\t\t\t\tSynchronization of products, product groups, and product brands<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                This scenario should be used when you want to synchronize products from POS, e-shop, or other production system into CareCloud. This step should be recommended before you start applying rewards and discounts or sending purchases after checkout.<\/p>\n

                                  \n
                                1. If you use product brands they should be synchronized with the endpoint POST \/product-brands\/batch<\/a>. It allows you to add multiple product brands in one request. Please consider splitting the request if you have more than 1000 records to make sure the synchronization will be successful.<\/li>\n
                                2. For product group synchronization CareCloud API provides endpoint POST \/product-groups\/batch<\/a> where you can synchronize all product groups from production systems. The batch method allows you to synchronize multiple product groups in a tree structure where you can mark parent groups if needed.<\/li>\n
                                3. The last synchronization endpoint is for the products themselves. Please use the API call of the endpoint POST \/products\/batch<\/a>. In this endpoint, you can synchronize multiple products and identify their brands and product groups.<\/li>\n
                                4. We recommend you synchronize brands, groups, and products depending on your needs (when a new entity appears in your system or when it is changed). Like brands, please consider the amount of records in one request for each endpoint.<\/li>\n
                                5. To avoid problems during synchronization, we recommend you keep an order of synchronization this way:\n
                                    \n
                                  1. Product brands<\/li>\n
                                  2. Product groups<\/li>\n
                                  3. Products<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

                                    \n\t\tNewsletter sign-up and other operations\n\t<\/h3>\n\t\t\t\t\tCreate a new card in CareCloud<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                    If you dont have generated card numbers, but you already has cads physically printed, this case help you to insert a new card into CareCloud.<\/p>\n

                                    There is a way how to do it through API. Otherwise, you have to import cards manually to the system via CDP administration and than use following use case<\/a>. <\/p>\n

                                      \n
                                    1. If you decide to use an API solution, you can create a new card. For that purpose, you need to know a card type. All card types are available in GET \/card-types<\/a>.<\/li>\n
                                    2. Now you know the card type, card number, and customer id. You can create a new card in the system. For that please call POST \/cards<\/a>.<\/li>\n
                                    3. If you have done everything right, you will get a card ID in the response.<\/li>\n
                                    4. In case of any error, please follow the error message to find a solution.<\/li>\n<\/ol>\n\t\t\t\t\tNewsletter sign-up<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                      CDP CareCloud creates a customer account if it doesn’t exist and adds a customer source dedicated to newsletters. This use case covers existing customers, customers who signed up for the newsletter, and new customers. <\/p>\n

                                      Customer source identifies the source of the customer (email, Facebook, registration, campaign summer 2021). It will tell you what the source of sign-up or registration is. Customers can have multiple customer sources.\u00a0 <\/p>\n

                                        \n
                                      1. [GET] \/customer-sources. <\/li>\n
                                      2. If you want to create a new customer source for an existing customer, you can do it at [POST] \/customers\/{cusomer_id}\/customer-source-records<\/a>. <\/li>\n
                                      3. When you have all the necessary data, you can call the action method POST \/customers\/actions\/newsletters-sign-up<\/a>. The method creates a customer if one does not exist and sets all concerts passed from the request and contact source.<\/li>\n<\/ol>\n

                                        If it’s a customer who has already signed up for the newsletter and wants to register, you don’t have to worry. Just follow the sign-up use case<\/a>. CDP & CRM CareCloud will handle this situation. <\/p>\n\t\t\t\t\tCreate a marketing automation event<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                        Marketing automation events are used to launch a scenario connected to an event. The scenario covers any available automation in the CareCloud platform.<\/p>\n

                                        Marketing Automation Events has the following structure of resources:<\/p>\n

                                         <\/p>\n

                                         <\/p>\n

                                        \"\"<\/p>\n

                                         <\/p>\n

                                         <\/p>\n

                                        Event group<\/b>: It is a general definition of an event. As an administrator, you can define event types that describe the behavior and structure of following events.<\/p>\n

                                        Event Properties<\/b>: A list of properties is defined with the event type. It is a good way to extend the event type possibilities.<\/p>\n

                                        Event: It is a resource that allows you to create an event for a specific customer. The event starts a Marketing Automation scenario. It can transfer data to the scenario. Marketing automation scenarios can use the data to make better decisions during their run.<\/b><\/p>\n

                                        Event property record<\/b>: It contains property values connected with an event.<\/p>\n

                                         <\/p>\n

                                        Create an event<\/i><\/p>\n

                                         <\/p>\n

                                          \n
                                        1. If you want to create an event through CareCloud REST API, know what event you wish to create. Correctly set it up, and check if it contains all the necessary properties. If you need to create a new event group, you can do it in the events section of the CareCloud administration. You can also create a new event type or property there. When everything is set up in CareCloud administration, we can go to the next step.<\/li>\n
                                        2. First, you must decide what event type you want to create an event. To help you decide, you might select an event type depending on the event group. List of the groups you can list with API call of resource GET \/event-groups<\/a>.<\/li>\n
                                        3. Depending on the results, you can select a list of event types that fits your event group or use other criteria from GET \/event-types<\/a>.<\/li>\n
                                        4. If you decided on an event type that fits your use case, you could check if you need to use any of the available properties here GET \/event-properties<\/a>.<\/li>\n
                                        5. Now is the time to create an event for a specific customer. The creation of events also contains values of properties. You set property records in events resource because we need to have all data available for the MA scenario in one API call to start immediately after. Call the method POST \/events<\/a> with parameters.<\/li>\n<\/ol>\n\t\t\t\t\tAbandoned cart<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                          If you want to inform a customer about his abandoned cart, you can trigger a scenario in the Marketing Automation application following the use case Create a marketing automation event<\/a>.<\/p>\n

                                          There are currently two options for how you can deal with it:<\/p>\n

                                            \n
                                          1. You will make a decision in your application or e-shop when the basket becomes abandoned. After that, you will create a marketing automation event.<\/li>\n
                                          2. If you can’t decide on the e-shop side, you can create a marketing automation event every time the shopping card is updated and resolve the abandoned login directly in the Marketing Automation application scenario in CareCloud.<\/li>\n<\/ol>\n\t\t\t\t\tStamper<\/a>\n\t\t\t\t\t\t\t\t\t\t\tExpand<\/i><\/a>\n\t

                                            This use case explains how to find and display a customer’s digital stamp card, including active campaigns, collected stamps, and any rewards or bonuses earned by reaching special checkpoints.<\/p>\n

                                            What is Stamper?<\/strong><\/p>\nThe Digital Stamper simulates a traditional store loyalty program, allowing customers to collect digital stamps with each purchase. Stamps are securely stored and linked to a unique customer ID for accurate tracking. Once a customer collects a certain number of stamps, they automatically receive a reward. Campaigns can also include expiration rules, tiered rewards, and bonus checkpoints. The digital format removes the hassle of physical cards and helps businesses increase engagement with a seamless loyalty experience.
                                            \n
                                            \nHow to display Stamper data for the customer?<\/strong>\n

                                              \n
                                            1. Find the right campaign<\/strong>Start by retrieving a list of stamper campaigns using GET \/stamper-campaigns<\/a> . You can filter the list to show only active campaigns relevant to your customer.
                                              This endpoint also supports accessing past campaign history. The response includes the full campaign definition-such as the number of stamps required, rewards, bonus checkpoints, and other campaign rules.<\/li>\n
                                            2. Get the customer’s stamper card<\/strong>Once you’ve identified the correct campaign, fetch the customer’s active stamp card using GET \/stamper-campaigns<\/a>. You can filter by both customer ID and campaign ID. You can also filter multiple cards using an array in query parameter for stamper campaign ID.
                                              It’s possible for a single customer to have multiple stamp cards within one campaign (e.g. if they completed a card and started a new one). You can filter the response to show only active (not yet completed) cards or retrieve all cards for a full campaign history.<\/li>\n
                                            3. Retrieve the list of stamps<\/strong>To see which stamps the customer has collected, use GET \/stamps<\/a>. This endpoint returns a list of stamps, which can be connected to both the customer and their stamp card.
                                              \nThe list of stamps is also available in the structure of each stamper card. You can use both ways depending on your use case.
                                              Each stamp includes details about:\n
                                                \n
                                              • Which purchase triggered the stamp.<\/li>\n
                                              • The position of the stamp on the card (e.g. 1st, 5th, 10th). That helps you to see what bonus was achieved (Check bonus definition in stamper campaign).<\/li>\n
                                              • What condition was fullfiled with that stamp (The list of condition is available in the stamper campaign).<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n

                                                \n\t\tMake the most of CareCloud!\n\t<\/h4>\n

                                                \n\t\tConnect the CareCloud platform with the cash register system online!\n\t<\/h2>\n\t

                                                Take full advantage of all customer benefits and connect the CareCloud platform with your POS system or e-commerce solution online. You’ll be able to checkout with all the advantages of centralized customer benefits administration. Whether it’s any benefit, voucher, coupon, or use of a points scheme, you will apply all benefits directly at checkout across all integrated systems.<\/p>\n

                                                There will be no difference between using customer benefits in a brick-and-mortar store, in an e-shop, when shopping on a mobile app, or at a sales kiosk. You decide which benefit is valid in all sales channels and which is valid only in the e-shop. Take advantage of the central administration of customer benefits!<\/p>\n\t\t\t\t\"kreslo\"\n

                                                \n\t\tJOIN OUR CLOUD\n\t<\/h4>\n

                                                \n\t\tReady to Meet CareCloud?\n\t<\/h2>\n\t

                                                Fill in your contact details to get answers to the questions you have about CareCloud – from product description and pricing to casual talk about your customers and your business.<\/p>\n

                                                One of our experts will contact you soon.<\/p>\n\t