Leat

Delete Contact Identifier (Contact Identifiers) via DELETE /contact-identifiers. Deletes an Contact Identifier. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Delete Category (Categories) via DELETE /product-categories/{uuid}. Delete a specific Category in the Leat system. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Delete Product (Products) via DELETE /products/{uuid}. Delete a specific Product in the Leat system. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Delete Shift (Shifts) via DELETE /shifts/{shift_uuid}. Deletes an existing Shift. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Delete Webhook Subscription (Webhooks) via DELETE /webhook-subscriptions/{webhook_subscription_uuid}. Removes an existing Webhook Subscription. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

List Automations (Automations) via GET /automations. Get an overview of all created Automations for an account.

Get Brand Kit (Brand Kit) via GET /brand-kit. Retrieve the details of your account's Brand Kit with this call. It allows you to access all the branding elements associated with your account, including logos, color schemes, and font styles.

List Collectable Rewards (Collectable Rewards) via GET /collectable-rewards. Retrieve a collection of Physical Rewards that still need to be picked up at the Shop by the Contact that has claimed them remotely.

List Contact Attributes (Contact Attributes) via GET /contact-attributes. Display a list of Contact Attributes for your Account, including both the default ones and any Custom Attributes you've created.

Find Contact Identifier (Contact Identifiers) via GET /contact-identifiers/find. Finds the Contact Identifier. Returns contact as null if not yet linked to a Contact.

Find Contact Session Token (Contact Session Tokens) via GET /contact-session-tokens/{contact_session_token}. Find a Contact's Session Token to identify and validate them.

List Contact Subscriptions (Contact Subscriptions) via GET /contact-subscriptions/{contact_uuid}. This function retrieves a comprehensive list of all subscriptions associated with a specific Contact, identified by their UUID. It provides an easy and efficient way to view the various subscriptions a Contact is enrolled in, ensuring you have up-to-date information on their engagement with your services.

Get Auth Token (Contact Verification) via GET /contact-verification/auth-token/{contact_uuid}. Retrieves an authentication token for a specific Contact, identified by their UUID. Allowing verification of the Contact's identity and granting secure access.

List Contacts (Contacts) via GET /contacts. Retrieve a list of Contacts with pagination. The pagination has default values, but you can alter those by supplying the page and limit parameters including values with the call. Please note: the attributes array is now deprecated.

Get Contact (Contacts) via GET /contacts/{contact_uuid}. Retrieve a specific Contact with the the using its UUID. Please note: the attributes array is now deprecated.

Get Contact Identifiers (Contacts) via GET /contacts/{contact_uuid}/contact-identifiers. Use this endpoint to retrieve a Contact's Contact Identifiers.

Get Credit Balance (Contacts) via GET /contacts/{contact_uuid}/credit-balance. Retrieve the current Credit Balance of a specific Contact, identified through their UUID.

Get Prepaid Balance (Contacts) via GET /contacts/{contact_uuid}/prepaid-balance. Use this function to retrieve the Prepaid Balance of a particular Contact, identified by their UUID.

Get Tier (Contacts) via GET /contacts/{contact_uuid}/tier. Use this endpoint to retrieve the current loyalty Tier of a specific Contact. It’s useful for understanding a Contact's loyalty status and offering them tailored Rewards based on their Tier.

Find Contact (Contacts) via GET /contacts/find-one-by. Find a Contact by email address. To find a Contact using an identifier, see Contact Identifiers. Please note: the attributes array is now deprecated.

Find or Create Contact (Contacts) via GET /contacts/find-or-create. Find Contact by email address or – if no Contact exists yet for this email address – our API creates a new Contact for the email address you just supplied and returns the newly created Contact in the response.

Find or Create Contact Async (Contacts) via GET /contacts/find-or-create/async. If a Contact needs to be retrieved or created *quickly* and any system values that are normally created upon contact creation aren't relevant, this can be used. This API call is much faster than the 'regular' find or create API call; only the Contact's UUID will be returned on the response in this instance.

Get Authenticated Url (Contacts Portal) via GET /contacts-portal/auth-url. This function generates a secure, authenticated URL specifically for a given Contact, identified by their UUID. This URL grants the Contact access to the portal, ensuring a safe and personalized experience.

Calculate Credits (Credit Receptions) via GET /credit-receptions/calculate. Without actually creating a Credit Reception, this API call can be used to calculate how many credits would be issued if a Credit Reception was to be made with the given values. Please note, that there is a (small) possibility of a divergence in credits between the calculation and the actual Credit Reception, if loyalty rule filters are in place that are time-based (e.g. a happy hour rule).

List Custom Attribute Groups (Custom Attribute Groups) via GET /custom-attribute-groups. Retrieve all Custom Attribute Groups for a specific entity.

List Custom Attributes (Custom Attributes) via GET /custom-attributes. Get a list of Custom Attributes for a specified entity.

List Forms (Forms) via GET /forms. Retrieve of all Forms linked to an Account. It's possible to filter both on status and type

List Giftcard Programs (Giftcard Programs) via GET /giftcard-programs. Retrieve a list of your Giftcard Programs.

List Giftcard Transactions (Giftcard Transactions) via GET /giftcard-transactions. This API call provides a list of all Giftcard Transactions. It offers filtering options based on per-page count, page number, Giftcard hash, Giftcard Program UUID, and Shop UUID.

Get Giftcard Transaction (Giftcard Transactions) via GET /giftcard-transactions/{giftcard_transaction_uuid}. Retrieve details of a specific Giftcard Transaction. By providing the transaction's UUID, you can access comprehensive information about individual transactions, allowing you to see and keep track of Giftcard Transactions, making it easier to manage Giftcards.

List Giftcards (Giftcards) via GET /giftcards. Returns a paginated list of Giftcards.

Get Giftcard (Giftcards) via GET /giftcards/{giftcard_uuid}. Finds a Giftcard by its UUID.

Find Giftcard by Hash (Giftcards) via GET /giftcards/find-one-by. Returns all relevant information for a Giftcard. Required for a create Giftcard Transaction call, as it provides all the necessary details.

Get Loyalty Program (Loyalty Program) via GET /loyalty-program. This method allows you to retrieve detailed information about a specific Loyalty Program. It provides key details such as the program's ID, name, maximum credit amount, custom_credit_name, and unit settings. This API call is allows for understanding the details of the Loyalty Program for your Account.

List Loyalty Transaction Attributes (Loyalty Transaction Attributes) via GET /loyalty-transaction-attributes. Retrieve a list of all Loyalty Transaction Attributes associated with your Loyalty Program. It's a helpful tool to view both standard and Custom Attributes, allowing for better understanding and management of the data collected through loyalty transactions.

List Loyalty Transactions (Loyalty Transactions) via GET /loyalty-transactions. Returns transactions for a Loyalty Program. The results can be filtered by Contact, Shop and Loyalty Transaction type.

List Orders (Orders) via GET /orders. Retrieve a paginated list of Orders, ordered by most recent.

Find Order (Orders) via GET /orders/find. Use the external_identifier to find an Order.

List Perks (Perks) via GET /perks. This API call fetches a list of all Perks with their Perk Options.

Get Perk (Perks) via GET /perks/{perk_uuid}. Retrieve a Perk with its Perk Options using its UUID.

Get Portal Session (Portal Sessions) via GET /portal-sessions/{portal_session_uuid}. Retrieve a Portal Session by supplying its UUID.

List Prepaid Transactions (Prepaid Transactions) via GET /prepaid-transactions. Returns a paginated list of Prepaid Transactions, which can be filtered either by Contact or Shop.

List Categories (Categories) via GET /product-categories. Retrieve all Categories.

Get Category (Categories) via GET /product-categories/{uuid}. Get a specific Category in the Leat system.

Find Category (Categories) via GET /product-categories/find. Use the external_identifier to find a Category.

List Products (Products) via GET /products. Lists all Products in the Leat system.

Get Product (Products) via GET /products/{uuid}. Get a specific Product in the Leat system.

Find Product (Products) via GET /products/find. Use the external_identifier to find a Product.

List Promotion Attributes (Promotion Attributes) via GET /promotion-attributes. Retrieve a list of all Promotion Attributes associated with your Account.

List Promotions (Promotions) via GET /promotions. Retrieves a list of all Promotions linked to an Account, providing detailed insights into each promotion's attributes such as name, description, voucher limits, and expiration periods.

Get Promotion (Promotions) via GET /promotions/{promotion_uuid}. Retrieve a specific Promotion by specifying its UUID.

List Referrals (Referrals) via GET /referrals. Retrieve a list of Referrals from your referral program.

Get Referral Program Settings (Referrals) via GET /referrals/settings. Retrieve a Referral program's settings, like the incentive for both the *referring* contact and the *referred* contact.

List Rewards (Rewards) via GET /rewards. This API endpoint is used to list Rewards available for to be shown in-store or to list Rewards that a specific Contact can claim, with potentially a subsequent Create Reward Reception call when a Contact claims a Reward. The list of Rewards for a particular Contact might differ from the full list of Rewards.

Get Reward (Rewards) via GET /rewards/{reward_uuid}. Retrieve a specific Reward by specifying its UUID.

List Teams (Shift Teams) via GET /shift-teams. Returns a paginated list of Teams for Shifts.

Get Team (Shift Teams) via GET /shift-teams/{uuid}. Retrieve a Team using its UUID.

Find Team by Name (Shift Teams) via GET /shift-teams/find. Returns all relevant information for a Team.

List Shift Types (Shift Types) via GET /shift-types. Returns a paginated list of Shift Types.

Get Shift Type (Shift Types) via GET /shift-types/{uuid}. Retrieve a Shift Type using its UUID.

Find Shift Type by Name (Shift Types) via GET /shift-types/find. Returns all relevant information for a Shift Type.

List Shifts (Shifts) via GET /shifts. Returns a paginated list of Shifts.

Get Shift (Shifts) via GET /shifts/{uuid}. Retrieve a Shift using its UUID.

Find Shift by External ID (Shifts) via GET /shifts/find. Returns all relevant information for a Shift.

List Shops (Shops) via GET /shops. Retrieve all Shops belonging to an Account. In case this call is used for a Loyalty flow, then please check for a Loyalty program. None of the Loyalty API calls where a Shop ID is required will work if the Shop used is not linked to a Loyalty Program.

Get Shop (Shops) via GET /shops/{shop_uuid}. Retrieve information of your Shop. This call is useful for getting insights into individual shop settings and attributes.

List Subscription Types (Subscription Types) via GET /subscription-types. Retrieves a list of all Subscription Types linked to an Account. Useful for getting an overview of the various communication categories and their enrollment strategies.

List Tiers (Tiers) via GET /tiers. This API call fetches a list of all Tiers available in your Loyalty Program. It's a handy way to view the different status levels that Contacts can achieve.

List Units (Units) via GET /units. Lists all Units for an account. These can subsequently be used to create Credit Receptions, where the unit_name parameter needs to be supplied if the default unit purchase_amount is not wished to be used.

List Visit (Visits) via GET /visits.

Show Visit (Visits) via GET /visits/{uuid}.

List Vouchers (Vouchers) via GET /vouchers. Retrieve a paginated list of all Vouchers for an Account, with the option to filter by Promotion, Contact, Voucher status, and more.

Find Voucher (Vouchers) via GET /vouchers/find. Finds a Voucher by its unique code. This call will help you with identifying individual Vouchers and viewing their specifications like whether the Voucher is redeemed or not or when it expires.

List Webhook Subscriptions (Webhooks) via GET /webhook-subscriptions. Lists an Account's current Webhook Subscriptions.

Get Webhook Subscription (Webhooks) via GET /webhook-subscriptions/{webhook_subscription_uuid}. Retrieve a specific Webhook Subscription by specifying its UUID.

Create Automation Run (Automations) via POST /automations/runs. This method triggers an Automation. Please note that only the Automation with the 'contact_updated' event can subsequently be used to create a run. This means that the event of the Automation that you provide should have a be of type 'contact_updated'. You can add an array at data, which can then be used in the Automation.

Create Booking (Bookings) via POST /bookings. Creates a new Booking.

Reverse Collectable Reward Redemption (Collectable Rewards) via POST /collectable-rewards/{collectable_reward_redemption_uuid}/reverse. Reverses a previous Collectable Reward Redemption, in the event of an order return or some other cancellation. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Contact Attribute (Contact Attributes) via POST /contact-attributes. This method allows you to create your own custom Contact Attribute. After the request, you get the created attribute as a response.

Create Contact Identifier (Contact Identifiers) via POST /contact-identifiers. Creates a Contact Identifier. You can link it directly to a Contact when you send a contact_uuid along.

Use Contact Session Token (Contact Session Tokens) via POST /contact-session-tokens/{contact_session_token}/use. Mark a session token as used, making it invalid for next attempts.

Send Contact Verification Email (Contact Verification) via POST /contact-verification/send. This function triggers the sending of a verification email to a Contact, provided they exist in the system. Therefore, it requires the Contact's email address to proceed. When doing so, the process of verifying their identity through email validation is initiated. The system checks for the existence of the Contact and the associated Contacts Portal before sending the email. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Verify Login Code (Contact Verification) via POST /contact-verification/verify. Validates the login code received by the Contact via email. This verification is a crucial step to ensure the Contact's identity and secure login. The function checks for the presence of the Contacts Portal and uses the provided code and email to complete the verification process.

Create Contact (Contacts) via POST /contacts. If a Contact needs to be created, only the email address is needed. To add any additional data to the Contact, a subsequent Update Contact API call can be used.

Create Anonymous Contact (Contacts) via POST /contacts/anonymous. Creates an anonymous Contact with a fictitious email address. This can be used whenever a new Contact cannot (yet) be identified by their email address, but some actions are already desired (e.g. creation of Credit Receptions). (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Contact Async (Contacts) via POST /contacts/async. If a Contact needs to be created *quickly* and any system values that are normally created upon creation aren't relevant, this function can be used. This API call is much faster than the 'regular' creation API call, focusing on basic Contact creation.

Delete Contact (Contacts) via POST /contacts/{contact_uuid}/delete. Deletes a Contact. This action is irreversible, the Contact's Credit Balance and any relation to other entities within the system will be removed, although the entities themselves may remain. When using 'DEFAULT' as the deletion type, a log is created containing detailed information. If 'GDPR' is used as the deletion type, any reference to personal data is removed. (Leat's full notes for this endpoint are longer; see docs.leat.com.) DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Merge Contact (Contacts) via POST /contacts/merge. WARNING: Use at your own risk and with consent from your clients. Before using, ensure both email addresses belong to the same person. Merges a 'source' Contact into a 'destination' Contact. The 'destination' Contact will be the resulting Contact, whilst the 'source' Contact will be removed. Note: This cannot be undone, so use with care. (Leat's full notes for this endpoint are longer; see docs.leat.com.) DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Credit Reception (Credit Receptions) via POST /credit-receptions. In creating a Credit Reception, you may either choose to set the unit_value alongside the relevant unit_name, or the credits, or both. In any case, one of either must be set. If only purchase amount is set, then the number of credits are determined by any Loyalty Rules set on the Loyalty Program. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Reverse Credit Reception (Credit Receptions) via POST /credit-receptions/{credit_reception_uuid}/reverse. At times, an initial Credit Reception needs to be reversed, because of a refund for instance. This will create a new Credit Reception with the same data as initially used, but for the negative number of credits issued. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Custom Attribute Group (Custom Attribute Groups) via POST /custom-attribute-groups. Custom Attributes can be grouped, which can be helpful to identify those attributes that are associated to your integration.

Create Custom Attribute (Custom Attributes) via POST /custom-attributes. Creates a new Custom Attribute for a specified entity. You need to provide essential details like the entity type, name, label, and data type of the attribute. There's also the option to add a description and, for select attributes, an array of options.

Create Giftcard Transaction (Giftcard Transactions) via POST /giftcard-transactions. This API call facilitates the creation of a transaction for a specific Giftcard. It handles both increment and decrement transactions. A negative amount will trigger a decrementation, adjusting the Giftcard's balance accordingly.

Reverse Giftcard Transaction (Giftcard Transactions) via POST /giftcard-transactions/{giftcard_transaction_uuid}/reverse. At times, an initial Giftcard Transaction needs to be reversed, because of a refund for instance. This will create a new Giftcard Transaction with the same data as initially used, but for the negative amount issued. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Giftcard (Giftcards) via POST /giftcards. This API call allows creation of Digital Giftcards, as the creation of Physical Giftcards is currently not supported. To create a Digital Giftcard, use type: 1 in your request.

Send Giftcard by Email (Giftcards) via POST /giftcards/{uuid}/send-by-email. This API call sends out an email containing giftcard information. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Loyalty Transaction Attribute (Loyalty Transaction Attributes) via POST /loyalty-transaction-attributes. Creating a Loyalty Transaction Attribute allows you to add new Custom Attributes to your Loyalty Program. This feature is essential for tailoring the program to specific data collection needs, such as capturing unique customer preferences or transaction details. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create And Process Order Return (Order Returns) via POST /order-returns/create-and-process. Creates a new Order Return and processes it at once (i.e. handling corrections for the initial Order). It returns both the Order Return entity itself and a result object. If an Order Action was configured for the Account and the original Order triggered a Run, this is executed in sync and will populate the result object. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Order (Orders) via POST /orders. Creates a new Order in the Leat system. It does not yet process the Order, so no Points Transaction will be created just yet. Call the Process Order endpoint to convert the Order into a Points Transaction. Alternatively, use the Create and Process Order endpoint instead. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Process Order (Orders) via POST /orders/{uuid}/process. Processes an existing Order in the Leat system and returns a result object. If an Order Action was configured for the Account, then this is executed in sync and will fill the result object. An example of such a result would be a transaction containing loyalty points.

Create And Process Order (Orders) via POST /orders/create-and-process. RECOMMENDED Creates a new Order in the Leat system and directly processes it. Returns both the Order entity itself and a result object containing the result of the Order Action as configured by the Client. Currently, the only type of Order Action supported is the creation of a Points Transaction. However, please take into account that more result types will be added in the future (e.g. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Simulate Order Result (Orders) via POST /orders/simulate. Simulates the result of a new Order in the Leat system. Please note that the actual result may differ, as some time-based rules may be in place. Also, some rules may not be applied if the required information is missing from the payload (e.g. contact).

Create Perk (Perks) via POST /perks. Creates a new Perk.

Create Portal Session (Portal Sessions) via POST /portal-sessions. When creating a portal session, a valid shop_uuid specifying the shop for which the portal session is to be created must be provided. Optionally, a contact_uuid can be provided, which will pre-fill the contact's details in the portal session. If no contact UUID is provided, the contact can be added in the portal session itself. It is also possible to specify the scanner_type that is being used. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Credit Reception Portal Session (Portal Sessions) via POST /portal-sessions/credit-reception. A portal session can also specifically be made for credit receptions. This is done by specifying the credit-reception endpoint. All other parameters are the same as when creating a regular portal session.

Create Pay Prepaid Portal Session (Portal Sessions) via POST /portal-sessions/pay-prepaid. A portal session can also specifically be made for prepaid transactions. This is done by specifying the pay-prepaid endpoint. All other parameters are the same as when creating a regular portal session.

Create Redeem Giftcard Portal Session (Portal Sessions) via POST /portal-sessions/redeem-giftcards. A portal session can also specifically be made for redeeming giftcards. This is done by specifying the redeem-giftcards endpoint. This session type requires a purchase amount, amount_in_cents, to be provided. It is also possible to specify whether multiple giftcards can be used for a single transaction by supplying the allow_multiple_giftcards parameter (defaults to true).

Create Top Up Giftcard Portal Session (Portal Sessions) via POST /portal-sessions/top-up-giftcards. A portal session can also specifically be made for topping up giftcards. This is done by specifying the top-up-giftcards endpoint. All other parameters are the same as when creating a regular portal session.

Create Top Up Prepaid Portal Session (Portal Sessions) via POST /portal-sessions/top-up-prepaid. A portal session can also specifically be made to top up a contact's prepaid balance. This is done by specifying the top-up-prepaid endpoint. All other parameters are the same as when creating a regular portal session.

Create Voucher Portal Session (Portal Sessions) via POST /portal-sessions/vouchers. A portal session can also specifically be made for vouchers. This is done by specifying the vouchers endpoint. All other parameters are the same as when creating a regular portal session.

Create POS Transaction (POS Transactions) via POST /pos-transactions. Creates a POS Transaction in the Piggy system. You may choose to set a transaction ID and/or a terminal ID.

Push POS Transaction (POS Transactions) via POST /pos-transactions/{pos_transaction_uuid}/push. Send a push to Device after a POS Transaction creation, so a Credit Reception may be created using the Device.

Create Prepaid Transaction (Prepaid Transactions) via POST /prepaid-transactions. This API call generates a Prepaid Transaction for a specified Contact. Necessary parameters include either the Contact's UUID or their unique identifier value, the amount in cents for the transaction, and the Shop UUID where the transaction is occurring. Using this method ensures and accurate and up-to-date record of the Contact's Prepaid balance.

Reverse Prepaid Transaction (Prepaid Transactions) via POST /prepaid-transactions/{prepaid_transaction_uuid}/reverse. At times, an initial Prepaid Transaction needs to be reversed, because of a refund for instance. This will create a new Prepaid Transaction with the same data as initially used, but for the negative amount issued. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Category (Categories) via POST /product-categories. Creates a new Category in the Leat system and returns the Category entity.

Batch Create Categories (Categories) via POST /product-categories/batch. Creates a batch of Categories in the Leat system. Accepts up to 250 Categories per request. The maximum allowed payload size is 1MB.

Find or Create Category (Categories) via POST /product-categories/find-or-create. Finds an existing Category or creates a new Category in the Leat system and returns the Category entity.

Create Product (Products) via POST /products. Creates a new Product in the Leat system and returns the Product entity.

Batch Create Products (Products) via POST /products/batch. Creates a batch of Products in the Leat system. Accepts up to 100 Products per request. The maximum allowed payload size is 1MB.

Find or Create Product (Products) via POST /products/find-or-create. Finds an existing Product or creates a new Product in the Leat system and returns the Product entity.

Create Promotion Attribute (Promotion Attributes) via POST /promotion-attributes. Globally create a Promotion Attribute for the Account in question, customizable to your wishes.

Create Reward Reception (Reward Receptions) via POST /reward-receptions. Create a Reward Reception by specifying the Contact's UUID and the desired Reward's UUID. It enables a Contact to claim a Reward. Our backend manages various scenarios, like insufficient credits, stock limitations, Reward limits, and inactivity of Rewards, ensuring a correct Reward claiming process. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Reverse Reward Reception (Reward Receptions) via POST /reward-receptions/{reward_reception_uuid}/reverse. At times, a Reward redemption needs to be reversed, because of a canceled order for instance. This will create a new Credit Reception with the same data as initially used, to reissue the credits used. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Create Team (Shift Teams) via POST /shift-teams. Creates a new Team for Shifts.

Create Shift Type (Shift Types) via POST /shift-types. Creates a new Shift Type.

Create Shift (Shifts) via POST /shifts. Creates a new Shift.

Create Unit (Units) via POST /units. Create a new Unit for your Account with this API call. By default, a Unit always exists for an Account. If is_default is set to true, the newly created Unit will be the default Unit for the Account, meaning this will be used for Credit Receptions if Unit is not specified. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Visit (Visits) via POST /visits. Create a new Visit in the Leat system and returns the Visit entity.

Create Voucher (Vouchers) via POST /vouchers. Creates a new Voucher for a Promotion. Only the promotion_uuid is required. A specific code can be given to be used, or else a code will be generated by the system. Similarly, if no activation_date and/or expiration_date is given, the system will calculate those dates by the validity rules set up for the promotion. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Batch of Vouchers (Vouchers) via POST /vouchers/batch. Create multiple Vouchers at once for a specific Promotion. Specify the quantity and, optionally, a Contact UUID, activation_date and/or expiration_date. The system will generate a batch of Vouchers according to the Promotion's rules.

Reverse Voucher Redemption (Vouchers) via POST /vouchers/{uuid}/reverse. Reverses a Voucher Redemption. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Lock Voucher (Optional) (Vouchers) via POST /vouchers/{voucher_uuid}/lock. Using the lock functionality, you can make sure that a Voucher cannot be used by another process at the same time as well as return the Voucher to its ACTIVE state when a failure occurs on your side (using the Release call). Using the locking method, you can make sure the Voucher only reaches a REDEEMED state when everything completed successful on your side. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Release Voucher (Optional) (Vouchers) via POST /vouchers/{voucher_uuid}/release. When using Voucher locking, there is also the process of releasing the Voucher. Using the call you can release the Voucher from its lock using the release key that was retrieved during the initial lock. Extra information: When redeeming a Voucher that was previously locked, the system will release the lock automatically (you need to provide the release key as well). (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Check Voucher Validity (Vouchers) via POST /vouchers/{voucher_uuid}/validate. Validates if the Voucher can be redeemed at this point by the Contact.

Multi Redeem Voucher (Vouchers) via POST /vouchers/multi-redeem. Redeems a Voucher multiple times at once for a Contact. If the Voucher isn't yet linked to a Contact – because a series of Vouchers were printed as flyers to be given away for instance – then the contact_uuid is required as well as the Voucher code. Please note that when using locked Vouchers, you should send in your release_key here as well.

Redeem Voucher (Vouchers) via POST /vouchers/redeem. Redeems a Voucher for a Contact. If the Voucher is already linked to a Contact – because it was sent in an automated email for instance – the call only requires the Voucher's code for redeeming it. If the Voucher isn't yet linked to a Contact – because a series of Vouchers were printed as flyers to be given away for instance – then the contact_uuid is required as well as the Voucher code. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Create Webhook Subscription (Webhooks) via POST /webhook-subscriptions. Subscribes to a specific Webhook event. Pass version to choose the envelope your endpoint receives — see Webhook versions. Leave it out and you get V1, so pass V2 for anything new. An integration has one subscription per event type. (Leat's full notes for this endpoint are longer; see docs.leat.com.)

Update Booking (Bookings) via PUT /bookings/{uuid}. Updates the attributes of a Booking. Shop and contact cannot be updated.

Redeem Collectable Reward (Collectable Rewards) via PUT /collectable-rewards/collect/{loyalty_transaction_uuid}. To collect a Reward, the UUID of the Loyalty Transaction needs to be stated as query parameter inside the URI. It updates the existing Reward resource and sets the has_been_collected property to true.

Update Contact Identifier (Contact Identifiers) via PUT /contact-identifiers. Updates a Contact Identifier. Note: only the identifier's name and active properties can be updated. The value cannot be updated.

Link Contact Identifier (Contact Identifiers) via PUT /contact-identifiers/link. Links an existing, unlinked Contact Identifier to an existing Contact.

Unlink Contact Identifier (Contact Identifiers) via PUT /contact-identifiers/unlink. Removes a linked Contact from a Contact Identifier. DESTRUCTIVE AND IRREVERSIBLE: Leat publishes no undo, no restore and no recycle bin for this, and on a loyalty ledger a reversal, a merge or an unlink cannot be replayed.

Subscribe Contact (Contact Subscriptions) via PUT /contact-subscriptions/{contact_uuid}/subscribe. This call enables the subscription of a specific Contact to a chosen Subscription Type. By providing the Contact's UUID and the desired Subscription Type's UUID, you can easily enroll a Contact in a particular subscription.

Unsubscribe Contact to Subscription Type (Contact Subscriptions) via PUT /contact-subscriptions/{contact_uuid}/unsubscribe. This function allows for the removal of a specific Contact from a particular Subscription Type. By specifying the Contact's UUID and the Subscription Type's UUID, you can easily manage the Contact's subscription status.

Claim Anonymous Contact (Contacts) via PUT /contacts/{anonymous_contact_uuid}/claim. This function enables the conversion of an anonymous Contact (registered with a fictional email address) into a recognized Contact with a real email address. If a Contact already exists with the provided real email address, the anonymous and existing Contacts will be merged.

Update Contact (Contacts) via PUT /contacts/{contact_uuid}. Contact's attributes. Please note that system values or system defined attributes, such as 'credit balance' or 'created at', cannot be updated. Example payload: json { "attributes": { "firstname": "John", "lastname": "Doe", "example_custom_attribute": "Hello", } }

Update Custom Attribute (Custom Attributes) via PUT /custom-attributes/{custom_attribute_name}. Updates the properties of a Custom Attribute. Note that only the label, description, options for selects and multiselects, group can be updated. Attributes defined by the system cannot be updated.

Update Order (Orders) via PUT /orders/{uuid}. Use the uuid to update an existing Order.

Update Perk (Perks) via PUT /perks/{perk_uuid}. Updates an existing Perk.

Update Category (Categories) via PUT /product-categories/{uuid}. Updates a Category in the Leat system and returns the updated Category entity.

Update Product (Products) via PUT /products/{uuid}. Updates a Product in the Leat system and returns the updated Product entity.

Update Reward (Rewards) via PUT /rewards/{reward_uuid}. You can modify both global values and custom Reward Attributes. If you need to update a custom attribute—one that you've created specifically for a Reward—simply include it in the parameters, just as you would with the title, description, and required credits.

Update Team (Shift Teams) via PUT /shift-teams/{uuid}. Updates the attributes of a Team.

Update Shift Type (Shift Types) via PUT /shift-types/{uuid}. Updates the attributes of a Shift Type.

Update Shift (Shifts) via PUT /shifts/{uuid}. Updates the attributes of a Shift. Shop and contact cannot be updated.

Update Visit (Visits) via PUT /visits/{uuid}. Updates the attributes of a Visit. Shop and contact cannot be updated.

Update Voucher (Vouchers) via PUT /vouchers/{voucher_uuid}. Update the status of a Voucher. This endpoint allows you to activate or deactivate a Voucher, changing its usability status as needed.

Update Webhook Subscription (Webhooks) via PUT /webhook-subscriptions/{webhook_subscription_uuid}. Updates an existing Webhook Subscription. The subscription's event_type and secret cannot be altered after creation.