Product Catalog
Search Products
Search the product catalog with optional merchant, category, and useCase filters.
How to call — GET {server}/api/v1/business/products/search with X-API-Key and optional query parameters.
GET
Search Products
Authorizations
Your UGiftMe API key for authentication.
Format: Secure API key (e.g., <your-api-key>)
Required: All endpoints require this header
Example: X-API-Key: <your-api-key>
Query Parameters
Required range:
x >= 1Filter by category. Repeat this query parameter for multiple values (same encoding as the live API).
Filter by use case. Repeat this query parameter for multiple values.
Previous
Create New OrderCreates a single gift-card order against your integration wallet.
**How to call**
- Method: **POST**
- URL: `{server}/api/v1/business/orders`
- Headers: `X-API-Key`, optional `Idempotency-Key` (recommended for retries).
- Body: JSON matching **CreateOrderRequest** (`productCode`, `merchant`, `currency`, `valuePurchased`, optional recipient fields).
**Responses**
- **201** when the order is created synchronously (or idempotent replay).
- **202** when async processing is enabled (`orderRequestId`, `status: queued`); poll **GET** `/api/v1/business/orders/order-requests/{id}`.
- **402** when the wallet balance (after holds) is insufficient.
Next
Search Products
