List orders | Coi.co.il | API Documentation

{
  "ok": true,
  "data": [
    {
      "id": 4203,
      "number": 67,
      "createdAt": "2026-09-24T15:14:00+03:00",
      "updatedAt": null,
      "status": {
        "id": 7,
        "name": "בדרך ללקוח"
      },
      "paid": true,
      "payType": "credit_card",
      "total": 2340,
      "customer": {
        "id": null,
        "name": "ישראל ישראלי",
        "email": "israel@example.com",
        "phone": "0501234567",
        "address": "הרצל 13 תל אביב"
      },
      "customerNotes": "להשאיר ליד הדלת",
      "adminNotes": null,
      "trackingNumber": "RR123456789IL",
      "newsletter": false,
      "invoice": {
        "number": 10231,
        "url": "https://..."
      },
      "items": [
        {
          "productId": 1180,
          "name": "טלפון סלולרי 256GB",
          "sku": "886886000028",
          "quantity": 1,
          "unitName": null,
          "price": 3000,
          "optionsPrice": 600,
          "unitPrice": 3600,
          "total": 3600,
          "options": [
            {
              "name": "צבע: שחור",
              "price": 600
            }
          ],
          "vatFree": false
        }
      ],
      "delivery": {
        "name": "משלוח: איסוף עצמי",
        "price": 0
      },
      "coupon": {
        "code": "SUMMER",
        "description": "מבצע קיץ",
        "amount": -900
      },
      "promotions": [
        {
          "name": "הנחה על הסל",
          "amount": -360,
          "productId": null
        }
      ],
      "vat": null,
      "paypalFee": null,
      "payments": null,
      "fields": [
        {
          "name": "שם מלא",
          "value": "ישראל ישראלי"
        },
        {
          "name": "עיר",
          "value": "תל אביב"
        }
      ]
    }
  ],
  "hasMore": true,
  "nextCursor": "aToxNjQ2"
}

The store’s orders, newest first, in full. Requires orders:read.

Authentication

AuthorizationBearer

An API key from the store's admin: חנות > API ומפתחות. Send it as Authorization: Bearer coi_sk_... (or X-Api-Key: coi_sk_...). Never in the URL - ?apikey= is refused with 400.

Query parameters

limitintegerOptional1-100Defaults to 50

Rows per page, 1 to 100.

cursorstringOptional

nextCursor from the previous page, as is. Omit for the first page.

statusintegerOptional

Only orders in this status.

paidbooleanOptional

Only paid (true) or unpaid (false) orders.

created_sincestringOptional

Only orders placed from then on. ISO 8601: 2026-09-27 or 2026-09-27T10:00:00+03:00.

created_untilstringOptional

Only orders placed before then. ISO 8601: 2026-09-27 or 2026-09-27T10:00:00+03:00.

Response

A page of orders.

oktrueOptional

datalist of objectsOptional

hasMorebooleanOptional

Whether there is another page.

nextCursorstring or nullOptional

Pass as cursor for the next page; null on the last page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error