rmaOrderCancel

Cancels an RMA order. The order can be cancelled from NEW, REQUESTED, or ACCEPTED processing status. Once in PROCESSING status, the order cannot be cancelled.

Required scope: edit_rma_orders

---

Mutation

mutation RmaOrderCancel($id: String!) {
  rmaOrderCancel(id: $id) {
    id
    returnNumber
    returnReference
    processingStatus
    deliveryStatus
    financialStatus
    fulfillmentStatus
    expectedResolution
  }
}

---

Cancellation behaviour by processing status

Processing Status	Behaviour
NEW	Immediately cancelled. Terminal.
REQUESTED	Immediately cancelled. Terminal.
ACCEPTED	Cancelled. Any pending shipments may need to be handled separately. Terminal.
PROCESSING	Cannot be cancelled — items are already being inspected.
COMPLETE	Cannot be cancelled — already in terminal state.
REJECTED	Cannot be cancelled — already in terminal state.

---

Arguments

Argument	Type	Required	Description
id	String	✅	Internal UUID of the RMA order to cancel

---

Example Variables

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

---

Example Response

{
  "data": {
    "rmaOrderCancel": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "returnNumber": 1001,
      "returnReference": "RMA-2024-1001",
      "processingStatus": "CANCELED",
      "deliveryStatus": "CANCELED",
      "financialStatus": "CANCELED",
      "fulfillmentStatus": "CANCELED",
      "expectedResolution": "REFUND"
    }
  }
}

---

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 RmaOrderCancel($id: String!) { rmaOrderCancel(id: $id) { id returnNumber returnReference processingStatus } }",
    "variables": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  }'

Node.js

const mutation = `
  mutation RmaOrderCancel($id: String!) {
    rmaOrderCancel(id: $id) {
      id
      returnNumber
      returnReference
      processingStatus
    }
  }
`;

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.rmaOrderCancel);

Python

import os
import requests

mutation = """
mutation RmaOrderCancel($id: String!) {
  rmaOrderCancel(id: $id) {
    id
    returnNumber
    returnReference
    processingStatus
  }
}
"""

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['rmaOrderCancel'])

PHP

<?php
$mutation = <<<'GQL'
mutation RmaOrderCancel($id: String!) {
  rmaOrderCancel(id: $id) {
    id
    returnNumber
    returnReference
    processingStatus
  }
}
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']['rmaOrderCancel']);

Go

package main

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

func main() {
	mutation := `
		mutation RmaOrderCancel($id: String!) {
			rmaOrderCancel(id: $id) {
				id
				returnNumber
				returnReference
				processingStatus
			}
		}`

	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"])
}