Zoey REST API reference ยท Interactive version: apidocs.zoey.com

Orders

Orders: Order History

Add

POST https://container-url.zoeysite.com/api/rest/sales2/orders/comment

Add a zoey order comment or order history comment using the order increment id.

Param Notes
customer_note The comment text. By default it's added as a Zoey order comment. It's added to the Order History (status history) instead when order_status or add_to_history is also sent.
customer_note_notify Notify the customer of the change. Only works with customer_note.
is_visible_on_front Makes the comment visible to the customer in emails, PDFs, and the order view in My Account.
add_to_history Set to true to add customer_note to the Order History without changing the order's status. The order keeps its current status. Ignored when customer_note is empty.
zoey_order_comment Used to set the Order Comment
order_status Changes the order's status. customer_note is added to the Order History along with the new status. Don't send an empty string: it sets the order's status to blank.

Example request body:

{
    "orderIncrementId": "100000045",
    "commentData": {
        "customer_note": "Order history comment from postman",
        "customer_note_notify": "1",
        "is_visible_on_front": "1",
        "add_to_history": true,
        "zoey_order_comment": "Zoey Order comment from postman",
        "order_status": "api_process"
    }
}

Get All

GET https://container-url.zoeysite.com/api/rest/orders/:orderId/comments

Example response (Get All), HTTP 200:

[
    {
        "created_at": "2020-11-16 21:32:10",
        "comment": null,
        "is_customer_notified": "0",
        "is_visible_on_front": "0",
        "status": "pending"
    },
    {
        "created_at": "2020-11-16 21:32:30",
        "comment": null,
        "is_customer_notified": "0",
        "is_visible_on_front": "0",
        "status": "processing"
    },
    {
        "created_at": "2020-11-16 21:32:31",
        "comment": "Invoice #100000064 Has Been Created.",
        "is_customer_notified": null,
        "is_visible_on_front": "0",
        "status": "processing"
    },
    {
        "created_at": "2020-11-16 21:32:59",
        "comment": "Inventory was returned to stock.",
        "is_customer_notified": null,
        "is_visible_on_front": "0",
        "status": "processing"
    },
    {
        "created_at": "2020-11-16 21:32:59",
        "comment": "Refunded amount of $80.00 offline.",
        "is_customer_notified": "2",
        "is_visible_on_front": "0",
        "status": "processing"
    },
    {
        "created_at": "2020-11-16 21:32:59",
        "comment": null,
        "is_customer_notified": "0",
        "is_visible_on_front": "0",
        "status": "closed"
    },
    {
        "created_at": "2020-11-20 22:22:22",
        "comment": "This is another new zoey order comment from API.",
        "is_customer_notified": "1",
        "is_visible_on_front": "0",
        "status": "closed"
    }
]