Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ugift.me/llms.txt

Use this file to discover all available pages before exploring further.

​
API Guide

Integrate directly with UGiftMe using https://api-stage.ugift.me/api/v1/business (sandbox) or https://api.ugift.me/api/v1/business (production).

​
Authentication

Send your integration API key on every request: X-API-Key: <your-api-key> Keys are issued from the dashboard. If an IP whitelist is configured on the key, calls must originate from an allowed address.

​
Verify Credentials

GET /api/v1/business/auth returns minimal integration metadata when X-API-Key is valid. Use it for health checks and connection tests.

​
Orders and async behaviour

When async order processing is enabled, POST /api/v1/business/orders responds with 202 Accepted and a body such as: 
{ "orderRequestId": "<id>", "status": "queued" }
Poll GET /api/v1/business/orders/order-requests/{orderRequestId} for status, result, and errors. Successful synchronous creation may still return 201 Created when async mode is off. Optional Idempotency-Key (header) is supported for POST /orders and POST /orders/bulk; reusing the same key with a different payload returns 400. Responses may include X-Account-Orders-Async (true / false) for diagnostics.

​
Webhook events (B2B)

Register URLs under /api/v1/business/webhooks. Allowed events values are:
  • Orders: order.queued, order.processing, order.succeeded, order.failed
  • Payments: payment.succeeded, payment.failed
  • Catalog / wallet: product.updated, wallet.updated
  • Interactive OpenAPI: use the UGiftMe API Reference tab (generated routes under /api-reference/, for example /api-reference/authentication/verify-credentials).