Skip to main content
The Gift Shop API powers a hotel’s online gift shop from end to end. Through a single session, you read the shop’s configuration, browse its categories and products, build a guest’s cart, and confirm it for payment, with gift-specific options such as a beneficiary, a personal message, and, on service vouchers, a hidden price. The Gift Shop API is stateful: you open a session, carry its identifier across calls, and the cart lives in that session until the guest pays.

​
How the shop works

A purchase runs as a connected sequence of steps:

Create a session

Open a session for the gift shop owner: a hotel or a hotel group, with an optional culture. The API returns a sessionId that you carry on every later call and that holds the cart through the journey.

Read the configuration

Pull the shop’s details, theme, and accepted payment methods to render the storefront: name, address, contact, colours, logo, and fonts.

Browse the catalogue

List the shop’s categories and search its active products. Each product carries its description, pictures, price (fixed or a range), quantity limits, validity, and taxes.

Build the cart

Add products to the guest’s cart, with the gift options: send the voucher to the shopper or to a beneficiary, attach a personal message, and, on Indirect products, hide the price. Update or remove items as the guest changes their mind.

Confirm the cart

Send the shopper’s details to confirm the cart. The response returns a redirectUrl to the payment page.

Payment

Once the guest is on that page, they enter their card and pay. Payment is hosted and handled by D-EDGE, so you never touch card details.

Retrieve the order

After payment, read the order from the session: the voucher codes, their expiry dates, the shopper, and the payment summary.

​
Two kinds of products

Every product carries a usage field that says where the guest uses the voucher:
  • Direct: a value voucher. The beneficiary spends it on the hotel’s or group’s online D-EDGE booking engine: the code entered on the payment page deducts its value from the total. Its price always appears on the voucher document.
  • Indirect: a service, such as a spa treatment or a dinner. The beneficiary redeems the voucher with the shop owner, at the hotel or within the group, which marks it as used in the D-EDGE platform. Its price can be hidden with hidePrice.
The field travels with each voucher through the cart and the order, so your interface can tell the guest where each purchase can be used.

​
Get started

Quick start

Create your first session and run your first call in a few minutes.

Reference

Every endpoint, grouped by stage of the journey.

Guidelines

Authentication, request conventions, and response formats.

Best practices

Patterns to run the shop reliably, from caching to session recovery.