Skip to main content
GET
/
orders
/
counts
Get Order Counts
curl --request GET \
  --url https://staging-api.puppetvendors.com/orders/counts \
  --header 'x-access-token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Return the number of orders in each fulfillment status for the authenticated vendor. Useful for building dashboard summary cards and status badges.

​
Use Cases

  • Dashboard counters — Show “5 pending, 2 partial, 45 fulfilled” at a glance
  • Alert badges — Highlight statuses that need attention (e.g. on-hold or error)

​
Headers

​
x-access-token
string
required
A valid vendor JWT. Requires orders:read scope.

​
Response

200
{
  "success": true,
  "data": {
    "pending": 5,
    "partial": 2,
    "fulfilled": 45,
    "onHold": 1,
    "error": 0,
    "cancelled": 3
  }
}

​
Error Responses

401
{ "success": false, "error": { "message": "Invalid or expired token" } }
403
{ "success": false, "error": { "message": "Insufficient scope", "code": "FORBIDDEN" } }

​
Example

curl -X GET "https://staging-api.puppetvendors.com/orders/counts" \
  -H "x-access-token: YOUR_VENDOR_JWT"