3PL / fulfillment scorecard: fill rate, perfect-order rate, and at-risk

orders (chargeback exposure) aggregated across all reconciled orders.

GET /v1/fulfillment

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/fulfillment' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "at_risk": [
    {
      "reference": "ORD-10042",
      "severity": "string",
      "top_issue": "string",
      "variance_count": 1
    }
  ],
  "fill_rate": 8,
  "orders": 1,
  "orders_with_shipment": 1,
  "perfect_order_rate": 8,
  "perfect_orders": 1,
  "total_ordered": "string",
  "total_shipped": "string",
  "total_warehouse_shipped": "string",
  "variance_counts": {},
  "warehouse_fill_rate": 8
}

orders (chargeback exposure) aggregated across all reconciled orders.

Response

FulfillmentScorecard

at_risk · AtRiskOrder[] · required

Orders carrying chargeback risk, worst first.

Show AtRiskOrder

reference · string · required

severity · string · required

top_issue · string · required

The most severe variance kind on the order.

variance_count · integer · required

fill_rate · integer (int32)

min(shipped, ordered) / ordered as a percent 0–100 — the true fill rate (over-shipping doesn’t inflate it; it shows up as a variance).

orders · integer · required

Orders with a purchase order.

orders_with_shipment · integer · required

Orders that also have a shipment notice or warehouse advice.

perfect_order_rate · integer (int32)

perfect_orders / orders percent.

perfect_orders · integer · required

Orders with zero variances.

total_ordered · string · required

total_shipped · string · required

total_warehouse_shipped · string · required

variance_counts · object · required

Variance count by kind (short_shipped, over_shipped, …).

warehouse_fill_rate · integer (int32)

min(warehouse_shipped, ordered) / ordered percent — 3PL execution.

Status codes

Code	Meaning
200	Fulfillment scorecard
403	Admin credential required

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/fulfillment' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "at_risk": [
    {
      "reference": "ORD-10042",
      "severity": "string",
      "top_issue": "string",
      "variance_count": 1
    }
  ],
  "fill_rate": 8,
  "orders": 1,
  "orders_with_shipment": 1,
  "perfect_order_rate": 8,
  "perfect_orders": 1,
  "total_ordered": "string",
  "total_shipped": "string",
  "total_warehouse_shipped": "string",
  "variance_counts": {},
  "warehouse_fill_rate": 8
}