List a purchase order's history

GET/v1/api/store/{team_slug}/purchase_order/{hash_id}/history

v1Operation ID v1_public_purchase_order_history

Lists the activity recorded on a purchase order, newest first: who changed what, and when. The list is paged: pagination gives total, count, perPage, currentPage and totalPages. Ask for the next page with page; the page size is the team's setting (50 unless changed), and per_page is ignored.

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 purchase order's id (not its number, such as PO0042). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed

Query parameters

• pageinteger

  The page to return. Pages hold the team's page size (pagination_per_page in team settings: 50 unless changed, 5 to 100). per_page is not read here.

  • Default 1
  • Minimum 1
  • Example 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (7)

  • actionstring | nullrequired

    What happened to it.

  • created_atstring (date-time)required
  • idstringrequired
  • objectobject | array | nullrequired

    The details recorded for this change, free-form by type and action, plus user (id, name, avatar_url) when a person made it.

  • typestring | nullrequired

    What kind of record changed.

  • message_keystring | null

    The key of the sentence the web app shows for it.

  • teamobject
    Child fields (3)

    • idstring
    • namestring
    • slugstring
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

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.

  When

  No purchase order with this id in the team. error.code is null and error.message names the record type.

  Fix

  Check the id.

Related

• POSTExport purchase orders by issue date/v1/api/store/{team_slug}/purchase_order/export

Example request

curl

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

Example response 200

Response

{
  "data": [
    {
      "action": "purchase_order_changes",
      "created_at": "2026-11-01T09:00:00+00:00",
      "id": "31fxd6nKDhY683",
      "message_key": "purchase_order.purchase_order_changes",
      "object": {
        "changes": [
          {
            "key": "name",
            "new": "Fall restock",
            "old": null,
            "type": "string"
          }
        ],
        "purchase_order": {
          "id": "12vR7n9WUYn1CJ",
          "scoped_id": "PO0042"
        },
        "team": {
          "id": "GxZz8zgogK5dkh",
          "name": "Example Print Shop"
        },
        "user": {
          "avatar_url": "https://example.com/avatars/alex.png",
          "id": "lOURnovd3hkIQI",
          "name": "Alex Rivera"
        }
      },
      "team": {
        "id": "g9NXwcqzTRIABH",
        "name": "Example Print Shop",
        "slug": "your-team"
      },
      "type": "purchase_order"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}