Skip to main content
POST
/
api
/
v1
/
business
/
orders
Create New Order
curl --request POST \
  --url https://api-stage.ugift.me/api/v1/business/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "productCode": "<string>",
  "merchant": "<string>",
  "currency": "GBP",
  "valuePurchased": 123,
  "recipientEmail": "jsmith@example.com",
  "recipientName": "<string>",
  "giftMessage": "<string>"
}
'
{ "_id": "65b0d1e2f3a4b56789012345", "productCode": "AMAZON_UK_STD", "merchant": { "name": "Amazon UK", "distributionMethod": "EMAIL", "voucherCode": "XXXX-XXXX-XXXX-XXXX", "redemptionUrl": "https://www.amazon.co.uk/gc/redeem" }, "currency": "GBP", "valuePurchased": 50, "status": "active", "isPaid": true, "isActive": true, "usageLimit": 1, "giftOrder": { "message": "Thanks for being a great customer!", "recipientEmail": "alex@example.com", "recipientName": "Alex" }, "transactionId": "txn_01HZZ9K2M4P8Q6R7S8T9V0W1X", "createdAt": "2025-04-12T14:22:10.000Z", "updatedAt": "2025-04-12T14:22:11.000Z", "imageUrl": "https://cdn.ugift.me/products/amazon-uk-card.png" }

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
​
productCode
string
required
​
merchant
string
required
​
currency
string
required
Example:

"GBP"

​
valuePurchased
number
required
​
recipientEmail
string<email>
​
recipientName
string
​
giftMessage
string

Response

Order created (sync path or idempotent replay)

Account-facing order shape. List/search responses include imageUrl from withImageUrl; synchronous 201 creates may include populated product instead of imageUrl.

​
_id
string
Example:

"65b0d1e2f3a4b56789012345"

​
productCode
string
Example:

"AMAZON_UK_STD"

​
product
object

Populated product on synchronous 201 order responses.

Example:
{
  "imageUrl": "https://cdn.ugift.me/products/amazon-uk-card.png",
  "merchant": "Amazon UK",
  "productCode": "AMAZON_UK_STD"
}
​
merchant
object
​
currency
string
Example:

"GBP"

​
valuePurchased
number
Example:

50

​
status
string
Example:

"active"

​
isPaid
boolean
Example:

true

​
isActive
boolean
Example:

true

​
isActivated
boolean
Example:

false

​
usageLimit
number
Example:

1

​
giftOrder
object
​
transactionId
string
Example:

"txn_01HZZ9K2M4P8Q6R7S8T9V0W1X"

​
createdAt
string<date-time>
Example:

"2025-04-12T14:22:10.000Z"

​
updatedAt
string<date-time>
Example:

"2025-04-12T14:22:11.000Z"

​
imageUrl
string
Example:

"https://cdn.ugift.me/products/amazon-uk-card.png"

​
previousUserId
string

Present on some gift/recipient flows.