Skip to main content
GET
/
v2
/
vendor
/
fulfillments
List Fulfillments
curl --request GET \
  --url https://api.puppetvendors.com/v2/vendor/fulfillments \
  --header 'x-access-token: <api-key>'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve a paginated list of line items with their fulfillment status and tracking information, scoped to the authenticated vendor. Only line items belonging to the vendor are returned. Use this endpoint to monitor pending and completed fulfillments.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

​
Use Cases

  • Fulfillment dashboard — Monitor pending and completed fulfillments for the vendor
  • Shipping integration — Pull unfulfilled items for 3PL or warehouse systems
  • Order management — Track the vendor’s fulfillment queue

​
Query Parameters

​
fulfillmentStatus
string
Filter by fulfillment status. One of: fulfilled, unfulfilled.
​
shipmentStatus
string
Filter by shipment status (max 50 characters).
​
dateMin
string
Filter by date (minimum, ISO 8601). Example: 2024-01-01T00:00:00Z.
​
dateMax
string
Filter by date (maximum, ISO 8601).
​
search
string
Search in order name/number or line item name (max 200 characters).
​
first
integer
Number of items to return, forward pagination (1-100).
​
after
string
Cursor for forward pagination.
​
last
integer
Number of items to return, backward pagination (1-100).
​
before
string
Cursor for backward pagination.

​
Response

200
{
  "success": true,
  "data": {
    "items": [
      {
        "_id": "507f1f77bcf86cd799439015",
        "orderId": 5123456789,
        "orderNumber": 1042,
        "orderName": "#1042",
        "lineItemName": "Widget Pro - Large / Blue",
        "lineItemSku": "WP-LG-BL",
        "quantity": 2,
        "fulfillment": {
          "status": "fulfilled",
          "trackingCompany": "Royal Mail",
          "trackingNumber": "RM123456789GB",
          "trackingUrl": "https://tracking.royalmail.com/RM123456789GB",
          "createdAt": "2024-06-16T09:00:00.000Z"
        },
        "shippingAddress": {
          "name": "Jane Doe",
          "address1": "123 High Street",
          "city": "London",
          "country": "United Kingdom",
          "zip": "SW1A 1AA"
        },
        "date": "2024-06-15T10:30:00.000Z"
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": false,
      "startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxNSJ9",
      "endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAyNSJ9",
      "totalCount": 85
    }
  }
}

​
Example

curl -X GET "https://api.puppetvendors.com/v2/vendor/fulfillments?fulfillmentStatus=unfulfilled&first=20" \
  -H "x-access-token: YOUR_VENDOR_JWT_TOKEN"