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>'
import requests

url = "https://staging-api.puppetvendors.com/fulfillments/counts"

headers = {"x-access-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://staging-api.puppetvendors.com/fulfillments/counts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/fulfillments/counts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://staging-api.puppetvendors.com/fulfillments/counts"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-access-token", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://staging-api.puppetvendors.com/fulfillments/counts")
.header("x-access-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/fulfillments/counts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body
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"