curl --request POST \
  --url https://app.vaultgraph.com/api/commerce/orders/{id}/hold \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://app.vaultgraph.com/api/commerce/orders/{id}/hold"

payload = { "reason": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://app.vaultgraph.com/api/commerce/orders/{id}/hold', 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://app.vaultgraph.com/api/commerce/orders/{id}/hold",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vaultgraph.com/api/commerce/orders/{id}/hold"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.vaultgraph.com/api/commerce/orders/{id}/hold")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.vaultgraph.com/api/commerce/orders/{id}/hold")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "created_at": "2026-06-23T10:15:00.000Z",
    "checkout_id": "<string>",
    "currency": "GBP",
    "permalink_url": "<string>",
    "line_items": [
      {
        "id": "<string>",
        "item": {
          "id": "<string>",
          "title": "<string>",
          "price": 123,
          "image_url": "<string>"
        },
        "quantity": {
          "total": 1,
          "fulfilled": 1
        },
        "status": "processing",
        "totals": [
          {
            "type": "subtotal",
            "amount": 123,
            "display_text": "<string>"
          }
        ],
        "parent_id": "<string>",
        "properties": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totals": [
      {
        "type": "subtotal",
        "amount": 123,
        "display_text": "<string>"
      }
    ],
    "fulfillment": {
      "events": [
        {
          "id": "<string>",
          "line_items": [
            {
              "id": "<string>",
              "quantity": 123
            }
          ],
          "occurred_at": "2023-11-07T05:31:56Z",
          "type": "<string>",
          "carrier": "<string>",
          "description": "<string>",
          "tracking_number": "<string>",
          "tracking_url": "<string>"
        }
      ],
      "expectations": [
        {
          "destination": {
            "address_country": "<string>",
            "address_locality": "<string>",
            "address_region": "<string>",
            "extended_address": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "phone_number": "<string>",
            "postal_code": "<string>",
            "street_address": "<string>"
          },
          "id": "<string>",
          "line_items": [
            {
              "id": "<string>",
              "quantity": 123
            }
          ],
          "method_type": "digital",
          "description": "<string>",
          "fulfillable_on": "<string>"
        }
      ]
    },
    "ucp": {
      "capabilities": {},
      "version": "<string>"
    },
    "display_id": "ORD_1042",
    "status": "processing",
    "payment_status": "paid",
    "messages": [
      {
        "type": "info",
        "content": "<string>"
      }
    ],
    "permitted_actions": [
      "hold"
    ]
  }
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}