SSpiderIQ
SSpiderIQ

Docs / api-reference/commerce

Commerce

3 endpoints from the published OpenAPI import.

GET/api/v1/commerce/orders

List Orders

List the calling tenant's orders, newest first, with optional filters.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalse
offsetqueryintegerfalse
statusqueryanyfalse
contact_emailqueryanyfalse
sincequeryanyfalseISO-8601 lower bound on created_at (inclusive).
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/commerce/orders' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/commerce/orders",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/commerce/orders", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/commerce/orders", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
GET/api/v1/commerce/orders/stats

Order Stats

Aggregate order counts + revenue for the calling tenant over window.

Parameters

NameInTypeRequiredDescription
windowquerystringfalse7d | 30d | 90d | all
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/commerce/orders/stats' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/commerce/orders/stats",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/commerce/orders/stats", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/commerce/orders/stats", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
GET/api/v1/commerce/orders/{order_id}

Get Order

Fetch a single order by id, scoped to the calling tenant (404 otherwise).

Parameters

NameInTypeRequiredDescription
order_idpathstringtrue
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/commerce/orders/{order_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/commerce/orders/{order_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/commerce/orders/{order_id}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/commerce/orders/{order_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error