Branded storefront

Hotels sell gift vouchers best from their own website, on their own domain and design. The Gift Shop API gives you the full storefront tool set: the shop’s visual identity, its catalogue, a cart with gift options, and a payment page hosted by D-EDGE. Your storefront renders the shop; D-EDGE handles the money.

Prerequisites

An API key and the shop identifiers, delivered by D-EDGE. See Authentication.
A configured gift shop: the hotelier creates the products and sets their prices in the D-EDGE platform. The API exposes the catalogue; it does not manage it.

How it works

Open a session for the shop, then build the page from two reads. Get the gift shop configuration carries the identity: name, address, contact, rating, time zone, preferred culture, theme, and the accepted payment methods with the cards each of them takes. Search active products carries the offer. From there, Add a cart item and Confirm the cart close the sale, and the guest pays on the D-EDGE-hosted page.

Hotel shop or group shop

A gift shop is configured at hotel level or at group level in the D-EDGE platform, and the session’s owner must match that configuration. For a hotel-level shop, send both identifiers delivered by D-EDGE:

{
  "owner": { "groupId": 90001, "hotelId": 30001 },
  "culture": "en-GB"
}

For a group-level shop, hotelId is optional: leave it out, or send 0. Everything downstream follows the shop you opened: the configuration carries its identity, the catalogue its products, and the order its owner. For a group-level shop, one storefront serves every property, and a value voucher sold there is spendable on the booking engines of the group’s hotels. Open the session in the guest’s culture (product and category names follow it); you can switch the culture mid-journey with Update the session, without losing the cart.

Read the shop’s identity

The examples send the X-API-KEY header introduced in the Quick start. Replace {sessionId} with your session.

curl --request GET \
  --url 'https://{apiBaseUrl}/v1/{sessionId}/Configuration' \
  --header 'X-API-KEY: YOUR_API_KEY'

const response = await fetch("https://{apiBaseUrl}/v1/{sessionId}/Configuration", {
  headers: { "X-API-KEY": process.env.DEDGE_API_KEY },
});

const configuration = await response.json();

import os
import requests

response = requests.get(
    "https://{apiBaseUrl}/v1/{sessionId}/Configuration",
    headers={"X-API-KEY": os.environ["DEDGE_API_KEY"]},
)

configuration = response.json()

$response = $client->get('v1/{sessionId}/Configuration', [
    'headers' => ['X-API-KEY' => getenv('DEDGE_API_KEY')],
]);

$configuration = json_decode($response->getBody(), true);

var request = new HttpRequestMessage(HttpMethod.Get,
    "/v1/{sessionId}/Configuration");

var response = await client.SendAsync(request);
var configuration = JsonDocument.Parse(
    await response.Content.ReadAsStringAsync()).RootElement;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{apiBaseUrl}/v1/{sessionId}/Configuration"))
    .header("X-API-KEY", System.getenv("DEDGE_API_KEY"))
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
JsonNode configuration = mapper.readTree(response.body());

The response carries everything the page shell needs:

{
  "details": {
    "name": "Example Hotel",
    "address": { "city": "Paris", "country": "France" },
    "contact": { "email": "hotel@example.com", "webSite": "https://www.example.com" },
    "picture": "https://cdn.example.com/hotel.jpg"
  },
  "theme": {
    "font": { "fontFamily": "DM Sans, sans-serif" },
    "brand": { "color": "#6172b8", "inverted": true },
    "header": { "color": "#f5f4f0", "inverted": false }
  },
  "paymentMethods": [
    { "name": "OnlinePayment", "cards": ["visa", "mastercard", "americanExpress"] },
    { "name": "ApplePay", "cards": [] }
  ]
}

Apply the theme’s fonts and colours to your layout, and show the accepted payment methods near the checkout button: guests decide faster when they see their wallet is supported.

Render the catalogue

Search active products returns the shop’s live catalogue in the session’s culture. Each product carries its pictures, description, usage, price (Fixed, or a Range the guest picks an amount in), quantity limits, and validity:

{
  "products": [
    {
      "id": 80001,
      "name": "Gift card",
      "category": { "id": 70001, "name": "Online" },
      "usage": "Direct",
      "price": {
        "priceType": "Range",
        "minAmount": { "amount": 150.0, "currency": "EUR" },
        "maxAmount": { "amount": 500.0, "currency": "EUR" }
      },
      "quantity": { "min": 1, "max": 10 },
      "validity": "365.00:00:00",
      "pictures": [{ "uri": "https://cdn.example.com/gift-card.jpg" }]
    }
  ]
}

For a Range price, render an amount picker bounded by minAmount and maxAmount. For a Fixed price, show the amount and send that exact amount when adding to the cart: the amount field is required in both cases, and a missing or different amount is rejected with a 400.

Tips

Cache the shell, not the cart. The configuration, categories, and localisation lists are stable; cache them. Read the cart from the API whenever you display it, so totals and taxes are always the server’s. See Best practices.
Bring the guest home after payment. Pass a confirmationUrl when you confirm the cart: after the D-EDGE-hosted payment, the guest lands back on your storefront.
Design for mobile first. A large share of gift purchases happens on a phone, often days before the occasion.

Get the gift shop configuration

Full schema for the configuration endpoint.

Search active products

The live catalogue, in the session’s culture.

Get started

Build

Resources

Prerequisites

How it works

Hotel shop or group shop

Read the shop’s identity

Render the catalogue

Tips

Get the gift shop configuration

Search active products

​Prerequisites

​How it works

​Hotel shop or group shop

​Read the shop’s identity

​Render the catalogue

​Tips

​Related

Get the gift shop configuration

Search active products

Prerequisites

How it works

Hotel shop or group shop

Read the shop’s identity

Render the catalogue

Tips

Related