Skip to main content
GET
/
api
/
v1
/
business
/
orders
/
search
Advanced Search
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/search \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "orders": [
    {
      "_id": "65b0d1e2f3a4b56789012345",
      "productCode": "AMAZON_UK_STD",
      "merchant": {
        "name": "Amazon UK"
      },
      "currency": "GBP",
      "valuePurchased": 50,
      "status": "active",
      "isPaid": true,
      "createdAt": "2025-04-12T14:22:10.000Z",
      "updatedAt": "2025-04-12T14:22:11.000Z",
      "imageUrl": "https://cdn.ugift.me/products/amazon-uk-card.png"
    }
  ],
  "pagination": {
    "total": 8,
    "totalPages": 1,
    "currentPage": 1,
    "limit": 10
  }
}

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>

Query Parameters

​
merchant
string
​
status
string
​
isActive
enum<string>
Available options:
true,
false
​
isPaid
enum<string>
Available options:
true,
false
​
startDate
string<date-time>
​
endDate
string<date-time>
​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:10
​
sortBy
string
default:createdAt
​
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Search results

​
success
boolean
required
Example:

true

​
orders
object[]
required
​
pagination
object
required