Order Details

GET

api

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

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

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

	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/{orderId}")

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

{
  "_id": "65b0d1e2f3a4b56789012345",
  "productCode": "AMAZON_UK_STD",
  "merchant": {
    "name": "Amazon UK",
    "distributionMethod": "EMAIL"
  },
  "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",
  "userId": "507f1f77bcf86cd799439011",
  "ownershipHistory": [
    {
      "action": "sent",
      "transferDate": "2025-04-12T14:22:10.000Z",
      "toEmail": "alex@example.com"
    }
  ]
}

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.

Show child attributes

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

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[]

Order Details

curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/orders/{orderId} \
  --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/{orderId}', 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/{orderId}",
  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/{orderId}"

	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/{orderId}")

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

{
  "_id": "65b0d1e2f3a4b56789012345",
  "productCode": "AMAZON_UK_STD",
  "merchant": {
    "name": "Amazon UK",
    "distributionMethod": "EMAIL"
  },
  "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",
  "userId": "507f1f77bcf86cd799439011",
  "ownershipHistory": [
    {
      "action": "sent",
      "transferDate": "2025-04-12T14:22:10.000Z",
      "toEmail": "alex@example.com"
    }
  ]
}

Authentication

Product Catalog

Orders & Dispatch

Financials

Webhooks

Outbound webhook events

Authorizations

Path Parameters

Response