Skip to content
GET /me: tenant adds locales (accepted by personal links), currency, approvalRequired and customFields (id, label, type, required, options). key adds webhookUrl.- Delivery corrections:
POST /orders/{orderId}:update-delivery merges recipient and recipient.address with the stored values. Send only changed fields, including on orders from personal-link claims. The merged recipient is validated as a whole; errors name the recipient.* field.
- Events:
personal_link.created, one per link, from every channel. The creating key finds it in the feed but does not receive it as a webhook.
- Campaigns: each offering includes the gift
name and images, including gifts made for your brand only. GET /campaigns/{campaignId} accepts an optional locale.
- Images:
GET /catalog/images/{fileId} also serves images of published gifts in active or completed campaigns.
- Personal links and orders: new
selection field. A link sent with {brandId, productIds}, and its claimed order, have selection: "CATALOG" and campaignId: null. All others have selection: null.
- Keys: per-tenant API keys, limited to brands and to the
CATALOG, ORDERS and PERSONAL_LINKS scopes; GET /me.
- Catalog: brands, categories, gifts for a delivery country with estimates in the tenant currency and EUR, sync with
updatedSince, campaigns, key-less image URLs.
- Orders: place with your own IDs and an
Idempotency-Key; list, read, correct delivery, cancel, and order messages.
- Personal links: batches with a result per recipient; list, read and cancel.
- Events: signed webhooks, the event feed
GET /events, and POST /webhooks:test.
- Environments: production at
api.luxorr.io and sandbox at api.sandbox.luxorr.io.
