Advanced Search

GET

api

business

orders

Advanced Search

curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/search \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-stage.ugift.me/api/v1/business/orders/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.ugift.me/api/v1/business/orders/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.ugift.me/api/v1/business/orders/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.ugift.me/api/v1/business/orders/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

Show child attributes

pagination

object

required

Show child attributes

Advanced Search

curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/search \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-stage.ugift.me/api/v1/business/orders/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.ugift.me/api/v1/business/orders/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.ugift.me/api/v1/business/orders/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.ugift.me/api/v1/business/orders/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

Authentication

Product Catalog

Orders & Dispatch

Financials

Webhooks

Outbound webhook events

Authorizations

Query Parameters

Response