List the messages of an order

GET/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message

v2Operation ID v2_public_order_message_index

Returns the conversation with the customer on a sales order or quote, oldest first, with each message's attachments. Shopify orders are not found here. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Needs permission to message this order's customer: the team owner, message_all_order, or message_self_order for orders the user created or is assigned to.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (14)

  • idstringrequired
  • actor_namestring | null

    The writer's name, by actor_type: the team member, contact, customer, guest, participant or vendor; the team's name for system. Null when it can't be found.

  • actor_typestring | null

    Who wrote it: user (a team member), contact, customer, guest, participant, vendor or system.

  • contact_idstring | null

    The contact who sent it, for replies.

  • created_atstring (date-time) | null

    Sent. ISO 8601 with offset, or null.

  • delivery_summaryobject | null

    Delivery state per recipient.

  • emailstring | null
  • namestring | null

    Sender name, for replies from the customer; null on messages your team sends (read actor_name).

  • order_idstring | null
  • order_scoped_idstring | null
  • preview_messagestring | null

    The first 200 characters. An email's preview keeps its HTML.

  • statusstring | null
  • typestring | null
  • user_idstring | null

    The team member who sent it.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• POSTSend a message to the customer/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message
• GETList messages/v2/api/store/{team_slug}/messages

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/message' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "actor_name": "Alex Rivera",
      "actor_type": "user",
      "contact_id": null,
      "created_at": "2026-11-03T09:00:00+00:00",
      "email": null,
      "id": "mD1A7NR38PtyNs",
      "name": null,
      "order_id": "V4keXwwxMQyXw7",
      "order_scoped_id": "SO1001",
      "preview_message": "<p>Hi Alex, your order is ready for pickup.</p>",
      "status": "pending",
      "type": "outbound",
      "user_id": "PydH0WtBhSeiNU"
    }
  ],
  "status": 200,
  "success": true
}