Returns

Return requests. Every example sets SOOQUNA_TOKEN from the environment; see authentication. Responses are from a test store, cut to two items per list.

Endpoint	Method	Path
List an order’s returns	GET	`/orders/{id}/returns`
List returns	GET	`/returns`
Get a return	GET	`/returns/{id}`
Approve, decline or close a return	POST	`/returns/{id}`

List an order’s returns

GET /orders/{id}/returns · Scope: read_returns

Parameter	In	Description
`id`	path	The resource’s ID.

curl -X GET "https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns", {
  method: "GET",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
  },
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.get(
    "https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/orders/0193a1b2-c3d4-7e5f-8a6b-000000000035/returns");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Response 200

{"data": []}

List returns

GET /returns · Scope: read_returns

Parameter	In	Description
`status`	query	For example `requested`.

curl -X GET "https://api.sooquna.com/admin/api/2026-10/returns?status=requested" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/returns?status=requested", {
  method: "GET",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
  },
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.get(
    "https://api.sooquna.com/admin/api/2026-10/returns?status=requested",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/returns?status=requested');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/returns?status=requested", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/returns?status=requested");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Response 200

{"data": []}

Get a return

GET /returns/{id} · Scope: read_returns

Parameter	In	Description
`id`	path	The resource’s ID.

curl -X GET "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c", {
  method: "GET",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
  },
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.get(
    "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Approve, decline or close a return

POST /returns/{id} · Scope: write_returns

Actions: approve (with instructions), decline (with reason), receive, close.

Parameter	In	Description
`id`	path	The resource’s ID.

curl -X POST "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "approve",
  "instructions": "Drop the parcel at any Aramex point within 7 days.",
  "notify_customer": true,
  "version": 1
}'

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c", {
  method: "POST",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "action": "approve",
    "instructions": "Drop the parcel at any Aramex point within 7 days.",
    "notify_customer": true,
    "version": 1
  }),
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.post(
    "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
    json={
        "action": "approve",
        "instructions": "Drop the parcel at any Aramex point within 7 days.",
        "notify_customer": True,
        "version": 1,
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode([
        'action' => 'approve',
        'instructions' => 'Drop the parcel at any Aramex point within 7 days.',
        'notify_customer' => true,
        'version' => 1,
    ], JSON_UNESCAPED_UNICODE),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "strings"
)

func main() {
  body := `{
  "action": "approve",
  "instructions": "Drop the parcel at any Aramex point within 7 days.",
  "notify_customer": true,
  "version": 1
}`
  req, err := http.NewRequest("POST", "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c", strings.NewReader(body))
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Post, "https://api.sooquna.com/admin/api/2026-10/returns/0193a1b2-a3f8-7a9d-860a-6961e749501c");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
req.Content = new StringContent("""
{
  "action": "approve",
  "instructions": "Drop the parcel at any Aramex point within 7 days.",
  "notify_customer": true,
  "version": 1
}
""", Encoding.UTF8, "application/json");
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Was this page helpful?