Get a comment

GET/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}

v2Operation ID v2_public_order_comment_show

Returns one comment. {hash_id2} is the comment's id. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

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
• hash_id2stringrequired

  The comment's id (a hash id).

  • Example fFupqL9CYkMYgE

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired

  A comment.

  Child fields (9)

  • commentstringrequired
  • idstringrequired
  • created_atstring (date-time) | null

    Created. ISO 8601 with offset, or null.

  • is_editedboolean
  • order_idstring | null
  • trashedboolean
  • typestring

    user_comment for comments people write.

  • updated_atstring (date-time) | null

    Last changed. ISO 8601 with offset, or null.

  • user_idstring | null

    The author.

• 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

• GETList the comments of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/index

Example request

curl

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

Example response 200

Response

{
  "data": {
    "comment": "Customer approved the proof by phone.",
    "id": "fFupqL9CYkMYgE",
    "is_edited": false,
    "order_id": "V4keXwwxMQyXw7",
    "trashed": false,
    "type": "user_comment",
    "user_id": "PydH0WtBhSeiNU"
  },
  "status": 200,
  "success": true
}