orderHold

Pauses fulfillment for an order. When an order is held, no further processing is performed — DeliveryOrders are not sent to the warehouse and no picking is triggered.

A common use case is payment verification: place the order on hold while verifying payment, then call orderResume once confirmed (or orderCancel if the payment fails).

Required scope: edit_orders

---

Mutation

mutation OrderHold($id: String!) {
  orderHold(id: $id) {
    id
    type
    state
    message
  }
}

---

Return type: DispatchableRequest

Field	Description
id	Unique identifier of this hold request
type	Request type — HOLD for this mutation
state	Processing state of the request
message	Human-readable status message

---

Arguments

Argument	Type	Required	Description
id	String	✅	Internal UUID of the order to put on hold

---

Example Variables

{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

---

Example Response

{
  "data": {
    "orderHold": {
      "id": "req-uuid-hold-001",
      "type": "HOLD",
      "state": "ACCEPTED",
      "message": "Order fulfillment paused"
    }
  }
}

---

Code Examples

curl

curl -X POST https://api-v3.happycolis.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "query": "mutation OrderHold($id: String!) { orderHold(id: $id) { id type state message } }",
    "variables": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  }'

Node.js

const mutation = `
  mutation OrderHold($id: String!) {
    orderHold(id: $id) {
      id
      type
      state
      message
    }
  }
`;

const response = await fetch('https://api-v3.happycolis.com/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
  body: JSON.stringify({
    query: mutation,
    variables: { id: '550e8400-e29b-41d4-a716-446655440000' },
  }),
});

const { data } = await response.json();
console.log(data.orderHold);

Python

import os
import requests

mutation = """
mutation OrderHold($id: String!) {
  orderHold(id: $id) {
    id
    type
    state
    message
  }
}
"""

response = requests.post(
    'https://api-v3.happycolis.com/graphql',
    headers={'Authorization': f'Bearer {os.environ["ACCESS_TOKEN"]}'},
    json={
        'query': mutation,
        'variables': {'id': '550e8400-e29b-41d4-a716-446655440000'},
    },
)

data = response.json()['data']
print(data['orderHold'])

PHP

<?php
$mutation = <<<'GQL'
mutation OrderHold($id: String!) {
  orderHold(id: $id) {
    id
    type
    state
    message
  }
}
GQL;

$ch = curl_init('https://api-v3.happycolis.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode([
        'query'     => $mutation,
        'variables' => ['id' => '550e8400-e29b-41d4-a716-446655440000'],
    ]),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'Authorization: Bearer ' . getenv('ACCESS_TOKEN'),
    ],
]);

$result = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($result['data']['orderHold']);

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	mutation := `
		mutation OrderHold($id: String!) {
			orderHold(id: $id) {
				id
				type
				state
				message
			}
		}`

	body, _ := json.Marshal(map[string]any{
		"query":     mutation,
		"variables": map[string]any{"id": "550e8400-e29b-41d4-a716-446655440000"},
	})

	req, _ := http.NewRequest("POST", "https://api-v3.happycolis.com/graphql", bytes.NewBuffer(body))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"))

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]any
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result["data"])
}