Skip to main content
GET
/
v1
/
fulfillments
List Fulfillments
curl --request GET \
  --url https://staging-api.puppetvendors.com/v1/fulfillments \
  --header 'x-access-token: <api-key>'
import requests

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

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/v1/fulfillments', 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/v1/fulfillments",
  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/v1/fulfillments"

	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/v1/fulfillments")
  .header("x-access-token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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

​
Overview

Returns a paginated list of line items with their fulfillment status, tracking info, and shipping/billing addresses. Only items with "paid" financial status are included.

​
Use Cases

  • Monitor fulfillment progress across all vendors
  • Build a shipping dashboard showing tracking numbers and carriers
  • Identify unfulfilled orders that need attention
  • Export fulfillment data for logistics reporting
  • Track shipment statuses (in_transit, delivered, etc.)

​
Query Parameters

​
vendorId
string
Filter by vendor ID.
​
start
string
Start date in YYYY-MM-DD format.
​
end
string
End date in YYYY-MM-DD format.
​
fulfillment
string
Filter: "fulfilled" or "unfulfilled".
​
shipment
string
Filter by shipment status (e.g. "in_transit", "delivered").
​
limit
number
Results per page. Default: 100.
​
offset
number
Number of results to skip. Default: 0.

​
Response

200
{
  "total": 42,
  "nextOffset": null,
  "fulfillments": [
    {
      "_id": "...",
      "orderNumber": 1042,
      "orderName": "#1042",
      "date": "2024-03-15T00:00:00.000Z",
      "vendorId": "...",
      "vendorName": "acme supplies",
      "lineItemName": "Classic T-Shirt - Large",
      "lineItemVariant": "Large / Blue",
      "lineItemSku": "TSH-LG-BLU",
      "fulfillment": {
        "status": "success",
        "trackingCompany": "Royal Mail",
        "trackingNumber": "RM123456789GB",
        "trackingUrl": "https://tracking.royalmail.com/...",
        "createdAt": "2024-03-16T10:00:00.000Z"
      },
      "shippingAddress": {
        "first_name": "John",
        "last_name": "Doe",
        "address1": "10 Downing Street",
        "city": "London",
        "country": "United Kingdom"
      }
    }
  ]
}

​
Example

# Unfulfilled items for a vendor
curl -X GET "https://api.puppetvendors.com/v1/fulfillments?vendorId=6157fa...&fulfillment=unfulfilled" \
  -H "x-access-token: YOUR_JWT_TOKEN"