--- title: List orders slug: list-orders docTags: createdAt: 2026-04-17T07:48:39.600Z --- { "id": "lEmU2jWNfXjEyMO6Ud73q", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.archbee.com/v2/orders", "servers": [ { "url": "https://api.archbee.com/v2/orders", "description": "Production server" }, { "url": "https://staging-api.archbee.com/v2/orders", "description": "Staging server" }, { "url": "https://{region}.api.archbee.com/{version}/orders", "description": "Regional server with variables" } ], "name": "List orders", "description": "Returns a list of orders with optional date filtering.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "page", "type": "integer", "example": 1, "description": "

Page number for pagination (1-indexed)

", "default": 1, "format": "int32", "minimum": 1 }, { "kind": "optional", "name": "limit", "type": "integer", "example": 20, "description": "Number of items per page", "default": 20, "format": "int32", "minimum": 1, "maximum": 100 }, { "kind": "optional", "name": "dateFrom", "type": "string", "example": "2025-01-01", "description": "Filter orders created on or after this date", "format": "date" }, { "kind": "optional", "name": "dateTo", "type": "string", "example": "2025-12-31", "description": "Filter orders created on or before this date", "format": "date" }, { "kind": "optional", "name": "status", "type": "string", "description": "Filter by order status", "enum": [ "pending", "confirmed", "shipped", "delivered", "cancelled", "refunded" ] } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "description": "

HTTP Bearer token authentication (JWT)

", "scheme": "bearer" } ] }, "responses": [ { "statusCode": "200", "description": "List of orders", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Order", "customType": "Order[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "", "example": "880e8400-e29b-41d4-a716-446655440003", "format": "uuid" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "", "example": "pending", "enum": [ "pending", "confirmed", "shipped", "delivered", "cancelled", "refunded" ] }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "readOnly": true, "description": "", "example": 159.98, "format": "double" }, { "name": "tax", "kind": "optional", "type": "number", "readOnly": true, "description": "", "example": 12.8, "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "readOnly": true, "description": "", "example": 172.78, "format": "double" }, { "name": "shippingAddress", "kind": "optional", "type": "object", "description": "Full mailing address", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "street", "kind": "required", "type": "string", "description": "", "example": "123 Main St" }, { "name": "street2", "kind": "optional", "type": "string", "description": "", "example": "Apt 4B" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Springfield" }, { "name": "state", "kind": "optional", "type": "string", "description": "", "example": "IL" }, { "name": "zipCode", "kind": "required", "type": "string", "description": "", "example": "62701", "pattern": "^\\d{5}(-\\d{4})?$" }, { "name": "country", "kind": "required", "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "US", "pattern": "^[A-Z]{2}$" } ] }, { "name": "metadata", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "tracking", "kind": "optional", "type": "object", "readOnly": true, "description": "Nested tracking info (populated after shipping)", "example": "", "schema": [ { "name": "carrier", "kind": "optional", "type": "string", "description": "", "example": "FedEx" }, { "name": "trackingNumber", "kind": "optional", "type": "string", "description": "", "example": 794644790132 }, { "name": "estimatedDelivery", "kind": "optional", "type": "string", "description": "", "example": "2025-07-15", "format": "date" }, { "name": "events", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "timestamp", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "location", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "", "example": "" } ] } ] }, { "name": "createdAt", "kind": "optional", "type": "string", "readOnly": true, "description": "", "example": "", "format": "date-time" }, { "name": "updatedAt", "kind": "optional", "type": "string", "readOnly": true, "description": "", "example": "", "format": "date-time" } ] }, { "name": "meta", "kind": "optional", "type": "object", "description": "Pagination metadata included in list responses", "modelRef": "#/components/schemas/PaginationMeta", "customType": "PaginationMeta", "schema": [ { "name": "page", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32", "minimum": 1 }, { "name": "limit", "kind": "optional", "type": "integer", "description": "", "example": 20, "format": "int32", "minimum": 1, "maximum": 100 }, { "name": "total", "kind": "optional", "type": "integer", "description": "", "example": 142, "format": "int64", "minimum": 0 }, { "name": "totalPages", "kind": "optional", "type": "integer", "description": "", "example": 8, "format": "int32", "minimum": 0 } ] } ], "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "KyzZ0O2O5mVw51TduRVqS", "language": "curl", "code": "curl -X GET \"https://api.archbee.com/v2/orders?page=1&limit=20\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"\n" }, { "id": "hTfp7D_4ByiTzu9CCA0aG", "language": "python", "code": "import requests\n\nresponse = requests.get(\n \"https://api.archbee.com/v2/orders\",\n headers={\"Authorization\": \"Bearer YOUR_TOKEN\"},\n params={\"page\": 1, \"limit\": 20}\n)\norders = response.json()\n" }, { "id": "bTjV95n0m4eoNz89oHUyy", "language": "javascript", "code": "const response = await fetch(\"https://api.archbee.com/v2/orders?page=1&limit=20\", {\n headers: { \"Authorization\": \"Bearer YOUR_TOKEN\" }\n});\nconst orders = await response.json();\n" }, { "id": "Fn33YfPKBak-nPHiBM20I", "language": "ruby", "code": "require \"net/http\"\nrequire \"json\"\n\nuri = URI(\"https://api.archbee.com/v2/orders?page=1&limit=20\")\nreq = Net::HTTP::Get.new(uri)\nreq[\"Authorization\"] = \"Bearer YOUR_TOKEN\"\nres = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }\norders = JSON.parse(res.body)\n" } ], "selectedLanguageId": "KyzZ0O2O5mVw51TduRVqS" }, "hasXCodeSamples": true, "results": { "languages": [ { "id": "MRJ-uE1MtPln55PvWOyif", "language": "200", "code": "// List of orders\n{\n \"data\": [\n {\n \"id\": \"880e8400-e29b-41d4-a716-446655440003\",\n \"status\": \"pending\",\n \"items\": [\n {}\n ],\n \"subtotal\": 159.98,\n \"tax\": 12.8,\n \"total\": 172.78,\n \"shippingAddress\": {\n \"street\": \"123 Main St\",\n \"street2\": \"Apt 4B\",\n \"city\": \"Springfield\",\n \"state\": \"IL\",\n \"zipCode\": \"62701\",\n \"country\": \"US\"\n },\n \"metadata\": \"\",\n \"tracking\": {\n \"carrier\": \"FedEx\",\n \"trackingNumber\": 794644790132,\n \"estimatedDelivery\": \"2025-07-15\",\n \"events\": [\n {\n \"timestamp\": \"\",\n \"location\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"limit\": 20,\n \"total\": 142,\n \"totalPages\": 8\n }\n}" } ], "selectedLanguageId": "MRJ-uE1MtPln55PvWOyif" } }, "children": [ { "text": "" } ] }