Preview supplier POs (supplier-direct sends)
GET/api/send-plans/:sendPlan/supplier-purchase-orders
Preview the draft purchase orders that Draft supplier POs would create from the plan's supplier-direct suggestions, before anything is created: one entry per supplier × fulfillment network with its SKUs, units, estimated cost, lead time and arrival date, and the supplier's prep notes for that network. Nothing is created or changed.
send-plans:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Cost uses the same price the draft PO line gets: the supplier's price for the product, or its average cost when the supplier has no price (or a $0 price). unpriced counts SKUs that have neither and are counted at $0.
Query: line_ids[] (optional, integer[]): only these lines' suggestions; omit for every suggestion in the plan.
Response: orders (key, supplier_id, supplier_name, destination_warehouse_id, destination_label, color, skus, units, value, unpriced, lead_days, eta (Y-m-d), prep_notes), totals units, value and purchase_orders, and already_ordered (suggestions in scope that already have a PO and would be skipped).
Needs the send_planner.view permission. API tokens: send-plans:read.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.