PayPilot API
Live demoGitHub
HomeGuidesSDKsContext PluginAPI Reference
Supply agents

Book a (partial) goods receipt and re-run matching

POST
/api/v1/purchase-orders/{order_id}/goods-receipts

Book a (partial) goods receipt and re-run matching.

Authorization

HTTPBearer
AuthorizationBearer <token>

JWT access token

In: header

Path Parameters

order_id*string
Formatuuid

Query Parameters

merchant_id?|

Optional merchant to act on. Must be one you are a member of.

Formatuuid

Header Parameters

X-Merchant-ID?string|null

Request Body

application/json

lines*array<>
Items1 <= items
notes?string
Lengthlength <= 1000
Default""

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/purchase-orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/goods-receipts" \  -H "Content-Type: application/json" \  -d '{    "lines": [      {        "line_id": "6cb02bfb-65d4-467b-864d-461e923db664",        "quantity": 0      }    ]  }'
{  "data": {},  "meta": {},  "success": true}

Supplier agent reports a delivery delay (signed DELIVERY_UPDATE; reschedules the timeline) POST

Plays the supplier's side of the protocol: its agent sends a signed DELIVERY_UPDATE (status DELAYED), the PO's expected date moves, and the Gantt redraws the delivery and the PayPal payment that waits on it - in red, with the original plan underneath.

Purchase order lifecycle GET

Purchase order lifecycle.