Skip to main content
GET
/
api
/
v1
/
business
/
orders
/
{orderId}
Order Details
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/{orderId} \
  --header 'X-API-Key: <api-key>'
{
  "_id": "65b0d1e2f3a4b56789012345",
  "productCode": "AMAZON_UK_STD",
  "merchant": {
    "name": "Amazon UK",
    "distributionMethod": "EMAIL"
  },
  "currency": "GBP",
  "valuePurchased": 50,
  "status": "active",
  "isPaid": true,
  "isActive": true,
  "usageLimit": 1,
  "expiryDate": "2055-12-31T23:59:59.000Z",
  "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",
  "userId": "507f1f77bcf86cd799439011",
  "ownershipHistory": [
    {
      "action": "sent",
      "transferDate": "2025-04-12T14:22:10.000Z",
      "toEmail": "alex@example.com"
    }
  ]
}

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>

Path Parameters

​
orderId
string
required

Response

Order

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

​
expiryDate
string<date-time>
Example:

"2055-12-31T23:59:59.000Z"

​
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.

​
userId
string

Caller account id (detail endpoint only).

Example:

"507f1f77bcf86cd799439011"

​
ownershipHistory
object[]