Update an order | Coi.co.il | API Documentation

curl -X PATCH https://www.your-store.co.il/api/v1/orders/1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "status": 7,
  "trackingNumber": "RR123456789IL",
  "notifyCustomer": true
}'

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

Status, paid, tracking number and notes - what the admin order screen changes. Requires orders:write.

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.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

statusintegerOptional

One of the store's status ids (see status.id on orders; a wrong id is answered with the list).

paidbooleanOptional

trackingNumberstring or nullOptional<=100 characters

null clears it. Shown in the admin order screen and in the status email.

adminNotesstring or nullOptional

notifyCustomerbooleanOptionalDefaults to false

Email the customer that the status changed (with the tracking number when there is one). Sent only when the status really changed, is not 1 or 2, the order has an email, and "notify customers of status changes" is on in the store settings. customerNotified in the answer says whether it was sent.

Response

The updated order, plus customerNotified.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error