Get Purchase Order

Retrieve a purchase order with its line items, delivery terms, and financing state.

GET /v1/purchaseorder/:id

cURL

curl 'https://api.stateset.com/v1/purchaseorder/po_67890' \
  -H 'Authorization: Bearer <token>'

200

{
  "purchase_order_id": "po_67890",
  "status": "IN_PRODUCTION",
  "supplier_id": "did:stateset:supplier:xyz789",
  "buyer_id": "did:stateset:buyer:abc123",
  "amount": "100000.00",
  "currency": "USDC",
  "delivery_terms": {
    "incoterm": "FOB",
    "expected_delivery": "2024-08-15"
  },
  "financing": {
    "financing_id": "pof_9x3kLm8nR5",
    "advance_amount": "80000.00",
    "funding_schedule": [
      { "milestone": "ORDER_CONFIRMED", "amount": "40000.00", "funded_at": "2024-06-25T12:10:00Z" },
      { "milestone": "PRODUCTION_COMPLETE", "amount": "40000.00", "estimated_date": "2024-08-01" }
    ],
    "repayment_due": "2024-10-15"
  }
}

Overview

Returns the PO and, if it has been financed, the state of that financing — including which funding milestones have released.

Path

id · string · required

The purchase order identifier, e.g. po_67890.

Response

purchase_order_id · string · required

PO identifier.

status · string · required

DRAFT, REQUESTED, APPROVED, IN_PRODUCTION, COMPLETE, or CANCELLED.

supplier_id · string · required

Supplier DID.

buyer_id · string · required

Buyer DID.

amount · string · required

Total PO value.

currency · string · required

USDC or ssUSD.

line_items · array · required

What was ordered — SKU, quantity, and unit price per line.

delivery_terms · object · required

Incoterm, expected delivery date, and delivery address.

financing · object

Present only if the PO has been financed.

Show properties

financing_id · string

The financing position.

advance_amount · string

Total advanced against the PO.

funding_schedule · array

Milestone-gated tranches. Each carries a milestone, an amount, and either a funded_at if it has released or an estimated_date if it has not.

repayment_due · string

When the advance must be repaid.

cURL

curl 'https://api.stateset.com/v1/purchaseorder/po_67890' \
  -H 'Authorization: Bearer <token>'

200

{
  "purchase_order_id": "po_67890",
  "status": "IN_PRODUCTION",
  "supplier_id": "did:stateset:supplier:xyz789",
  "buyer_id": "did:stateset:buyer:abc123",
  "amount": "100000.00",
  "currency": "USDC",
  "delivery_terms": {
    "incoterm": "FOB",
    "expected_delivery": "2024-08-15"
  },
  "financing": {
    "financing_id": "pof_9x3kLm8nR5",
    "advance_amount": "80000.00",
    "funding_schedule": [
      { "milestone": "ORDER_CONFIRMED", "amount": "40000.00", "funded_at": "2024-06-25T12:10:00Z" },
      { "milestone": "PRODUCTION_COMPLETE", "amount": "40000.00", "estimated_date": "2024-08-01" }
    ],
    "repayment_due": "2024-10-15"
  }
}

A tranche with estimated_date and no funded_at has not released. Milestone funding is gated on the milestone actually being reached — treat the estimate as a forecast, not a commitment.

Related

• List Purchase Orders
• Finance Purchase Order
• Complete Purchase Order