Bulk operations

Endpoints for bulk operations. 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
Start a bulk export	POST	/bulk-operations
List bulk exports	GET	/bulk-operations
Get a bulk export	GET	/bulk-operations/{id}
Cancel a bulk export	POST	/bulk-operations/{id}/cancel

Start a bulk export

POST /bulk-operations · Any token

Exports a resource as JSONL to a signed download URL.

cURL

curl -X POST "https://api.sooquna.com/admin/api/2026-10/bulk-operations" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"resource": "products", "query": {"status": "active"}}'

Node.js

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/bulk-operations", {
  method: "POST",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"resource": "products", "query": {"status": "active"}}),
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

Python

import os
import requests

res = requests.post(
    "https://api.sooquna.com/admin/api/2026-10/bulk-operations",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
    json={"resource": "products", "query": {"status": "active"}},
)
res.raise_for_status()
print(res.json())

PHP

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/bulk-operations');
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(['resource' => 'products', 'query' => ['status' => 'active']], 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);

Go

package main

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

func main() {
  body := `{"resource": "products", "query": {"status": "active"}}`
  req, err := http.NewRequest("POST", "https://api.sooquna.com/admin/api/2026-10/bulk-operations", 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))
}

C#

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Post, "https://api.sooquna.com/admin/api/2026-10/bulk-operations");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
req.Content = new StringContent("""
{"resource": "products", "query": {"status": "active"}}
""", 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());

Response 201

{
  "completed_at": null,
  "created_at": "2026-10-18T09:30:00Z",
  "file_size": null,
  "id": "0193a1b2-c3d4-7e5f-8a6b-000000000003",
  "object_count": 0,
  "query": {"status": "active"},
  "resource": "products",
  "status": "created"
}

List bulk exports

GET /bulk-operations · Any token

cURL

curl -X GET "https://api.sooquna.com/admin/api/2026-10/bulk-operations" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

Node.js

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/bulk-operations", {
  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);

Python

import os
import requests

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

PHP

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/bulk-operations');
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);

Go

package main

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

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/bulk-operations", 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))
}

C#

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/bulk-operations");
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": [
    {
      "completed_at": null,
      "created_at": "2026-10-18T09:30:00Z",
      "file_size": null,
      "id": "0193a1b2-c3d4-7e5f-8a6b-000000000003",
      "object_count": 0,
      "query": {"status": "active"},
      "resource": "products",
      "status": "created"
    }
  ]
}

Get a bulk export

GET /bulk-operations/{id} · Any token

Parameter	In	Description
id	path	The resource’s ID.

cURL

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

Node.js

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003", {
  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);

Python

import os
import requests

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

PHP

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003');
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);

Go

package main

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

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003", 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))
}

C#

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003");
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

{
  "completed_at": null,
  "created_at": "2026-10-18T09:30:00Z",
  "file_size": null,
  "id": "0193a1b2-c3d4-7e5f-8a6b-000000000003",
  "object_count": 0,
  "query": {"status": "active"},
  "resource": "products",
  "status": "created"
}

Cancel a bulk export

POST /bulk-operations/{id}/cancel · Any token

Parameter	In	Description
id	path	The resource’s ID.

cURL

curl -X POST "https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003/cancel" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

Node.js

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003/cancel", {
  method: "POST",
  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);

Python

import os
import requests

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

PHP

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003/cancel');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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);

Go

package main

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

func main() {
  req, err := http.NewRequest("POST", "https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003/cancel", 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))
}

C#

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Post, "https://api.sooquna.com/admin/api/2026-10/bulk-operations/0193a1b2-c3d4-7e5f-8a6b-000000000003/cancel");
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());