Skip to content

Onboarding

  • Creates the tenant, or one per operator for a platform, with brands, logo and brand colour.
  • Agrees the delivery countries, the currency, and whether new orders and links need approval.
  • Sets up campaigns, if you use curated gift selections.
  • Creates workspace accounts for your team, including an Administrator.
  • Switches API access on, first in the sandbox, then in production.
  • Issues the first sandbox key, or lets your Administrator create it.
  • Moves sandbox orders through their statuses on request.
  • Reviews the integration before production access is switched on.

Sandbox:

  • Store the key in a secret store. Check it with GET /me, which also returns locales, currency, approval setting and custom order fields.
  • Set a webhook URL, call POST /webhooks:test, and verify the signature.
  • Load and sync the catalog for each country, or read your campaigns.
  • Place orders with your own externalOrderId. On a timeout, retry with the same Idempotency-Key.
  • Handle every status, including REQUESTED and CANCELLED.
  • Handle errors by code, at least out_of_stock, not_deliverable_to_country, not_cancellable and rate_limited.
  • Deduplicate events by id. Reconcile from the event feed on a schedule.
  • For personal links: handle rejected recipients in a batch, and the personal_link.claimed event.
  • Never store or log a key or webhook secret in plain text.

Production:

  • Ask Luxorr to switch on production API access.
  • Create production keys (lxr_live_…) and set production webhook URLs.
  • Replace sandbox IDs for brands, products and campaigns with production IDs.
  • Place one real order end to end together with Luxorr.

Contact your Luxorr account manager about the account, campaigns or orders. For a question about one order, post a message on that order.