Skip to main content
GET
/
api
/
v1
/
business
/
orders
/
order-requests
/
{id}
Queue Status
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/order-requests/{id} \
  --header 'X-API-Key: <api-key>'
{
  "orderRequestId": "65e4f5b6c7d8e90123456789",
  "status": "succeeded",
  "type": "single",
  "result": {
    "_id": "65b0d1e2f3a4b56789012345",
    "productCode": "AMAZON_UK_STD",
    "merchant": {
      "name": "Amazon UK"
    },
    "currency": "GBP",
    "valuePurchased": 50,
    "status": "active",
    "imageUrl": "https://cdn.ugift.me/products/amazon-uk-card.png"
  },
  "createdAt": "2025-04-12T14:20:00.000Z",
  "updatedAt": "2025-04-12T14:22:12.000Z"
}

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

​
id
string
required

Response

Order request

​
orderRequestId
string
Example:

"65e4f5b6c7d8e90123456789"

​
status
string
Example:

"succeeded"

​
type
string

single or bulk.

Example:

"single"

​
result
object

Present when the request completes successfully. Usually a BusinessOrder for single or BulkOrderCreatedResponse for bulk; may be an arbitrary object while workers evolve.

Example:
{
  "_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,
  "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"
}
​
error
string

Present when the request failed.

​
createdAt
string<date-time>
Example:

"2025-04-12T14:20:00.000Z"

​
updatedAt
string<date-time>
Example:

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