Submit PO to Supplier

PUT 
/api/purchase-orders/:purchase_order/submit

Submit (send) a purchase order to the supplier. Sends the purchase order email and records the order as submitted.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Requires permission: purchase_orders.approve

Body fields

• supplier_message (string, optional, max 5000) - vendor-facing note saved to the order before it is sent. Omit to keep the saved message; send an empty string to clear it.
• reason (string, optional, max 255) - recorded against the submission snapshot.
• notify_supplier (boolean, optional, default true) - send false to record the order as submitted without emailing the supplier. This is the only way to submit an order whose supplier has no purchase order email on file; with true (the default) such an order is rejected with 422.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.