Get an order approval

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

v2Operation ID v2_public_order_approval_show

Returns one order approval. {hash_id2} is the approval's id. An old (version 1) order answers 404 here, as an unknown order does. {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 approval's id (a hash id).

  • Example xTKi8BqFVVmlL6

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired

  An approval.

  Child fields (18)

  • idstringrequired
  • statusstring | nullrequired

    pending (created, not emailed), sent-to-customer, viewed-by-customer, need-changes or completed (approved). When it was completed without a status, the Record answer shows null and later reads show "".

  • typestringrequired

    order for a whole-order approval, job for an artwork approval.

    • One of: "order", "job"
  • approved_bystring

    contact when a contact of the order's customer answered in the customer portal (see approved_by_contact_id), user when a team member recorded the answer (as Record the customer's answer does), customer otherwise, including before any answer.

    • One of: "contact", "user", "customer"
  • approved_by_contact_idstring | null

    The contact who answered in the customer portal, or null (always null when a team member recorded the answer).

  • approved_by_userstring | null

    The team member who recorded the answer, or null.

  • completedboolean

    true once the customer (or you, for them) answered: approved or changes needed.

  • completed_atstring (date-time) | null

    When the customer answered. ISO 8601 with offset, or null.

  • created_atstring (date-time) | null

    Created. ISO 8601 with offset, or null.

  • customer_last_viewed_contact_idstring | null

    The contact who last opened it in the customer portal, or null when that isn't known.

  • customer_last_viewed_datestring (date-time) | null

    When the customer last opened it. ISO 8601 with offset, or null.

  • itemsarray of objects

    Job approvals: the mockups under review.

  • job_idstring | null
  • notes_from_customerstring | null
  • notes_to_customerstring | null
  • order_idstring
  • order_scoped_idstring
  • signaturestring | null

    The signer's typed name.

• 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 order approvals of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval

Example request

curl

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

Example response 200

Response

{
  "data": {
    "approved_by": "customer",
    "approved_by_contact_id": null,
    "approved_by_user": null,
    "completed": false,
    "created_at": "2026-11-03T09:00:00+00:00",
    "customer_last_viewed_contact_id": null,
    "customer_last_viewed_date": null,
    "id": "xTKi8BqFVVmlL6",
    "notes_to_customer": "Please review the sizes and colors.",
    "order_id": "V4keXwwxMQyXw7",
    "order_scoped_id": "SO1001",
    "status": "sent-to-customer",
    "type": "order"
  },
  "status": 200,
  "success": true
}