Cognis
Commerce Catalog

List Orders

GET
/org/{orgId}/ecom/commerce/orders

List Cognis OLTP storefront orders for an organization (all brands).

Required scopes: org:ecom:collections:read

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

orgId*string

Organization ID (prefix: org_)

Query Parameters

page?integer
Default1
Range1 <= value
limit?integer
Default10
Range1 <= value
search?string
fromDate?string
toDate?string
dateBy?string
Default"placedAt"
sort?array<>
Default[{"field":"placedAt","order":"desc"}]
fields?array<>
Default["id"]
filters?
commerceProductId?string
Length1 <= length
financialStatus?string
Value in"pending" | "paid" | "partially_refunded" | "refunded" | "voided" | "failed"
internalStatus?string
Value in"open" | "requires_review" | "on_hold" | "closed" | "cancelled"
requiresInventoryReview?string
Value in"1" | "true"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/v1/org/string/ecom/commerce/orders"
{
  "success": true,
  "data": [],
  "message": "Success",
  "traceId": "req_abc123"
}
{
  "success": false,
  "message": "Invalid data",
  "errors": [
    {
      "code": 400,
      "message": "Invalid data"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unauthorized",
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Forbidden",
  "errors": [
    {
      "code": 403,
      "message": "Forbidden"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Not found",
  "errors": [
    {
      "code": 404,
      "message": "Not found"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Conflict",
  "errors": [
    {
      "code": 409,
      "message": "Conflict"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "string",
  "errors": [
    {
      "code": 0,
      "message": "string",
      "details": {}
    }
  ],
  "traceId": "string",
  "params": {},
  "readableMessage": "string"
}
{
  "success": false,
  "message": "Rate limit exceeded",
  "errors": [],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unexpected error",
  "errors": [
    {
      "code": 500,
      "message": "Unexpected error"
    }
  ],
  "traceId": "req_xxx"
}