Magento comments no longer syncing to Shipworks via API
Issue
Order comments and customer notes from our Magento 2 store are no longer appearing in ShipWorks. This started after a Magento upgrade. We need ShipWorks to display both admin order comments and customer checkout notes in the order comments/notes field.
Technical Details
Our Magento instance stores order notes in two separate locations within the REST API response (GET /rest/V1/orders). We need both of these mapped to the ShipWorks order notes field.
1. Admin Order Comments (status_histories)
These are comments added by our staff on orders (shipping instructions, internal notes, etc.). They are returned in the status_histories array on each order.
API path: order.status_histories[].
Example response:
{
"status_histories": [
{
"comment": "MARK. PLS ADD THESE TO DOUG's SHIPMENT AND RELEASE 3 FULL CASES. THX, JW",
"created_at": "2026-04-30 23:14:54",
"entity_name": "order",
"is_customer_notified": 0,
"is_visible_on_front": 0
}
]
}
2. Customer Checkout Notes (Amasty Order Attributes)
These are notes customers type at checkout (delivery instructions, shipping preferences, etc.). They are stored by the Amasty Order Attributes extension and returned in extension_attributes.amasty_.
API path: order.extension_attributes. where attribute_code = "comment"
Example response:
{
"extension_attributes": {
"amasty_order_attributes": [
{
"attribute_code": "comment",
"value": "please ship on Monday May 11 as I'm out of town"
}
]
}
}
What We Need
Both of these data sources should appear in the ShipWorks order notes/comments area so our shipping team can see all relevant notes when fulfilling orders. Ideally they would be combined into one view, with the source clearly identified (admin comment vs. customer note).
Test Order
Order #1000095153 contains both types of notes and can be used for testing:
- Admin comments in
status_histories(multiple staff notes) - Customer checkout note in
extension_attributes.amasty_with value "please ship on Monday May 11 as I'm out of town"order_attributes
Please sign in to leave a comment.
Comments
0 comments