Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Add Order Comment

POST

https://api.zid.sa/v1/managers/store/orders/{order_Id}/add-order-comment

The Add Order Comment API allows shipping and fulfilment partners to post real-time shipment updates directly to an order’s activity.

Partners can add up to 20 comments per order, each limited to 100 characters.

Comments are non-editable and include the app name for clarity.

These updates are visible to merchants in the order activity dashboard, improving communication and speeding up fulfilment-related issue resolution.

🔑Scopes

orders.read_write - Orders Read & Write

Request

Path Params

Header Params

Body Params application/json

Example

{
  "comment": "Customer asked to delay shipment by one day"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.zid.sa/v1/managers/store/orders/59214748/add-order-comment' \
--header 'Accept: application/json' \
--header 'Authorization: {{Autherization}}' \
--header 'X-manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36' \
--header 'store-id: 123' \
--header 'role: Manager' \
--header 'Content-Type: application/json' \
--data '{
  "comment": "Customer asked to delay shipment by one day"
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "status": "object",
    "order": {
        "id": 59214748,
        "invoice_number": 59214748,
        "code": "AIajhbzS7h",
        "store_id": 3,
        "order_url": "https://osama.zid.store/o/AIajhbzS7h/inv",
        "store_name": "Mohammed Zayan",
        "store_url": "https://osama.zid.store/",
        "order_status": {
            "name": "New",
            "code": "new"
        },
        "display_status": {
            "id": 1,
            "code": "new",
            "color": "#3498db",
            "name": "New"
        },
        "currency_code": "SAR",
        "customer": {
            "id": 37,
            "name": "Osama Khaled",
            "email": "osamakhaled2010@gmail.com",
            "mobile": "966503187421",
            "note": "",
            "verified": 1,
            "type": "individual"
        },
        "order_total": "211.44999892193000",
        "order_total_string": "211.45 SAR",
        "transaction_amount": 211.44999892193,
        "transaction_amount_string": "211.45 SAR",
        "payment_status": "paid",
        "created_at": "2025-10-13 07:53:13",
        "updated_at": "2026-01-21 19:42:31",
        "products": [
            {
                "id": "f28e9f26-4a9e-4159-bc50-d128ebe41d34",
                "name": "ايلف - برايمر ومرطب للوجه 24مل",
                "sku": "glow12",
                "quantity": 1,
                "is_taxable": true,
                "net_price_with_additions": 52.17,
                "tax_percentage": 0.15,
                "total": 60
            }
        ],
        "histories": [
            {
                "order_status_name": "New",
                "changed_by_type": "Merchant",
                "changed_by_details": {
                    "action": "Comment added",
                    "by": "Osama",
                    "comment": "Customer asked to delay shipment by one day"
                },
                "created_at": "2026-01-26 09:48:58",
                "humanized_created_at": "1 second ago"
            }
        ]
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-01-30 20:55:20

Change Order Status

View Order