API console
A developer tool, not an integration. Enter your prerelease store id and client secret, connect, and call any operation in the API. The requests you build here are the same ones your server will make — the difference is that your server holds the credentials, and this page does not.
Your secret stays in this browser tab. It is used to fetch a token and is discarded when you close the tab. We never store it.
api.prerelease.dillerapp.com. Production is not reachable from here.50 operations
Coupons8
GET/api/v2.0/stores/{storeId}/couponsGet store coupons
Retrieves store coupons. By default it only retrieves active coupons.
Path parameters
Query parameters
—
—
GET/api/v2.0/stores/{storeId}/coupon/{couponExternalId}Get coupon by external id
Retrieves a specific coupon by its external id. By default it only retrieves active coupons.
Path parameters
Query parameters
—
—
POST/api/v2.0/stores/{storeId}/couponCreate draft coupon
Creates a new draft coupon for the store.
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/couponsGet member coupons
This endpoint retrieves available coupons for a specific member. All other coupons that are not applicable to the follower, will not be returned.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/coupons/exemptionsGet member coupons exemptions
Path parameters
Request body
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/coupons/{couponCode}/validateValidate coupon
This endpoint validates a coupon code for a specific member.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/coupons/{couponCode}/reserveReserve coupon
This endpoint enables users to reserve a coupon for their pending orders, thereby ensuring that the coupon cannot be used for any other transactions. Call the /cancel-reservation endpoint after completing or cancelling a transaction to release the coupon reservation and make it available for other transactions.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/coupons/{couponCode}/cancel-reservationCancel coupon reservation
This endpoint should be called when a transaction is completed or cancelled to release the coupon reservation and avoid making it unavailable for other transactions.
Path parameters
—
—
Invitations3
POST/api/v2.0/stores/{storeId}/members/{memberId}/invite-friendInvite friend by email
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/invited-friendsReturns a list of all invited friends
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/invited-friendReturns an invited friend by invitation token
Path parameters
Query parameters
—
—
MemberIdentifiers3
POST/api/v2.0/stores/{storeId}/members/{memberId}/identifiersCreates a Member Identifier Value for a given member
Path parameters
—
—
PUT/api/v2.0/stores/{storeId}/members/{memberId}/identifiersUpdate identifier value
Path parameters
—
—
DELETE/api/v2.0/stores/{storeId}/members/{memberId}/identifiers/{id}Delete identifier value
Path parameters
—
—
Members17
POST/api/v2.0/stores/{storeId}/members/enrollEnroll member
Enrolls a member into the Loyalty Program. This will create a new member in the system and send an activation link via SMS to the member. If the member already exists, and GDPR is not accepted yet then a new activation link will be sent. If the store does not have SMS enabled, the activation link will be sent by email.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/membersRegister member
Adds a new member to the store. This will create a new member and automatically add him to the Loyalty Program, followed by a welcome SMS. If the store is not configured to send SMS, a welcome email is sent instead.
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}Get member by id
Path parameters
—
—
PUT/api/v2.0/stores/{storeId}/members/{memberId}Update member
Updates the member's data that is on the payload. Each request payload must include all data, even if it does not differ from what was previously inserted.
Path parameters
—
—
DELETE/api/v2.0/stores/{storeId}/members/{memberId}Delete member
This endpoint deletes a member. Note that while the member may not be immediately removed from the system, they will be marked for deletion and permanently removed after a period of 10 days.
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/searchGet member by filter
Searches members by email, phone number, activation token or any other identifier (country dependant - eg. SSN, licence plate, National ID)
Path parameters
Query parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/dependentsRetrieves a member's dependents
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/dependentsUpdate dependents
Atomically add, update, or delete dependent objects. The dependent collection should represent all members' dependents. To add a new dependent, set the id field to 0. To update a dependent, send the entire dependent object. To delete a dependent, remove it from the list.
Path parameters
Request body
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/widgets/profileGet member widget details
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/reset-phoneReset phone
Initiates the process of resetting or changing the member's phone number.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/reset-phone-verificationReset phone verification
Finishes the process of resetting or changing the member's phone number.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/login-otpLogin OTP
Sends a login OTP code that allows the member to login without the password. This endpoint is deprecated and will be removed in future versions. Please use the /otp endpoint with action 'login' instead.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/login-otp-verificationLogin OTP verification
Handles the verification of a One-Time Password (OTP) code during the login process. This endpoint is deprecated and will be removed in future versions. Please use the /otp-verification endpoint with action 'login' instead.
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/members/{memberId}/pointsGet member points
Get the member's points, qualification period and a list containing points expiring and the corresponding date of expiration.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/otpSend member OTP
Sends an OTP code to the member's phone, associated with a specific action (e.g., reset-phone, change-email, etc.). Mind that nothing else than the otp sending is done in this endpoint, regardless of the action.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/otp-verificationVerify member OTP
Verifies the OTP code sent to the member's phone. The action must match the one used when sending the OTP code.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/register-cardRegister card
Registers a card to the member's account.
Path parameters
—
—
MembershipLevel1
GET/api/v2.0/stores/{storeId}/membership-levelRetrieve store membership level information
Path parameters
—
—
NonEligibleProducts4
GET/api/v2.0/stores/{storeId}/non-eligible-productsGet non eligible products
Gets a paginated list of non-eligible products.
Path parameters
Query parameters
—
—
POST/api/v2.0/stores/{storeId}/non-eligible-productsAdd batch non eligible products
Add a batch of non-eligible products for a specific store, with a maximum limit of 100 products.
Path parameters
Request body
—
—
PUT/api/v2.0/stores/{storeId}/non-eligible-productsUpdate batch non eligible products
Update a batch of non-eligible products for a specific store, with a maximum limit of 100 products.
Path parameters
Request body
—
—
DELETE/api/v2.0/stores/{storeId}/non-eligible-products/{nonEligibleProductId}Delete non eligible product
Deletes a non-eligible product.
Path parameters
—
—
StampCards4
GET/api/v2.0/stores/{storeId}/members/{memberId}/stamp-cardsGet member active stamp cards
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/stamp-cardsGet store stamps
Retrieves store stamp cards. By default it only retrieves active stamp cards.
Path parameters
Query parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/stamp-cards/reserveReserve stamp
This endpoint enables users to reserve stamps for their pending orders, thereby ensuring that the stamps cannot be used for any other transactions. Call the /cancel-reservation endpoint after completing or cancelling a transaction to release the stamp reservation and make it available for other transactions.
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/stamp-cards/cancel-reservationCancel stamp reservation
Cancel reserved stamps from the member's current stamp card, affecting only the reserved stamps.
Path parameters
—
—
Stores7
GET/api/v2.0/storesGet all stores that the client has access to
—
—
GET/api/v2.0/stores/{storeId}Gets store
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/departmentsGet store departments
Path parameters
Query parameters
—
—
POST/api/v2.0/stores/{storeId}/departmentsAdd store department
Path parameters
—
—
GET/api/v2.0/stores/{storeId}/segmentsRetrieves all store's segments
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/otpSend anonymous OTP
Sends an OTP to a phone number belonging to an anonymous member (who has not yet enrolled).
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/otp-verificationVerify anonymous OTP
Verifies an OTP sent to a phone number belonging to an anonymous member (who has not yet enrolled).
Path parameters
—
—
Transactions3
POST/api/v2.0/stores/{storeId}/transactions/{externalTransactionId}/cancelCancel transaction
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/transactionsCreates transaction
Path parameters
—
—
POST/api/v2.0/stores/{storeId}/members/{memberId}/transactions/{transactionId}/refundCreate refund transaction
Allows for the partial refund of a previous transaction, without taking into account any coupons or stamp cards applied earlier. If the entire transaction needs to be refunded, consider using the "cancel transaction" endpoint, as it fully reverses the transaction, including coupons and stamp cards.
Path parameters
—
—