Skip to main content
POST
/
api
/
v1
/
business
/
orders
/
bulk
Bulk Order
curl --request POST \
  --url https://api-stage.ugift.me/api/v1/business/orders/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "orders": [
    {
      "productCode": "<string>",
      "merchant": "<string>",
      "currency": "GBP",
      "valuePurchased": 123,
      "recipientEmail": "jsmith@example.com",
      "recipientName": "<string>",
      "giftMessage": "<string>"
    }
  ]
}
'
{
  "success": true,
  "orders": [
    {
      "_id": "65b0d1e2f3a4b56789012345",
      "productCode": "AMAZON_UK_STD",
      "merchant": {
        "name": "Amazon UK"
      },
      "currency": "GBP",
      "valuePurchased": 25,
      "status": "active",
      "imageUrl": "https://cdn.ugift.me/products/amazon-uk-card.png"
    },
    {
      "_id": "65b0d1e2f3a4b56789012346",
      "productCode": "JL_UK_STD",
      "merchant": {
        "name": "John Lewis"
      },
      "currency": "GBP",
      "valuePurchased": 50,
      "status": "active",
      "imageUrl": "https://cdn.ugift.me/products/johnlewis-card.png"
    }
  ],
  "summary": {
    "totalOrders": 2,
    "totalValue": 75,
    "currency": "GBP",
    "remainingBalance": 1925.5
  },
  "rejectedOrders": [
    {
      "productCode": "UNKNOWN_CODE",
      "reason": "Product not found"
    }
  ]
}

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.

Authorizations

X-API-Key
string
header
required

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>

Headers

Idempotency-Key
string

Body

application/json
orders
object[]
required

Response

Bulk orders created (sync path or idempotent replay)

success
boolean
required
Example:

true

orders
object[]
required
summary
object
required
rejectedOrders
object[]