Skip to main content
GET
/
fulfillments
/
counts
Get Fulfillment Counts
curl --request GET \
  --url https://staging-api.puppetvendors.com/fulfillments/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

Returns the number of line items in each fulfillment status (unfulfilled, on-hold, fulfilled, return-in-progress). Vendor tokens are automatically scoped to your own items. Optionally filter by date range.

​
Use Cases

  • Display fulfillment status counters on your dashboard
  • Track how many orders are waiting to be shipped
  • Monitor return activity at a glance

​
Required Scope

fulfillments:read

​
Query Parameters

​
startDate
string
ISO 8601 lower bound on the date filter. Example: 2026-01-01T00:00:00Z.
​
endDate
string
ISO 8601 upper bound on the date filter.

​
Response

200
{
  "success": true,
  "data": {
    "counts": {
      "fulfilled": 120,
      "unfulfilled": 15,
      "on-hold": 3,
      "return-in-progress": 2
    }
  }
}

​
Example

curl -X GET "https://staging-api.puppetvendors.com/fulfillments/counts?startDate=2026-01-01T00:00:00Z&endDate=2026-05-19T23:59:59Z" \
  -H "x-access-token: YOUR_VENDOR_JWT"