Queue Status

GET

api

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>'

import requests

url = "https://api-stage.ugift.me/api/v1/business/orders/order-requests/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-stage.ugift.me/api/v1/business/orders/order-requests/{id}', 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/order-requests/{id}",
  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/order-requests/{id}"

	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/order-requests/{id}")

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

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

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

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.

Option 1
Option 2
Option 3

Show child attributes

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

Queue Status

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

import requests

url = "https://api-stage.ugift.me/api/v1/business/orders/order-requests/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-stage.ugift.me/api/v1/business/orders/order-requests/{id}', 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/order-requests/{id}",
  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/order-requests/{id}"

	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/order-requests/{id}")

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

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

Authentication

Product Catalog

Orders & Dispatch

Financials

Webhooks

Outbound webhook events

Authorizations

Path Parameters

Response