Skip to main content

Get Send Plan Product Detail

GET 
/api/send-plans/:sendPlan/products/:product

Everything the plan knows about one product: its source pool (row), every network line with its source lanes, step-by-step explanation and events (the audit trail of overrides, resets, resolutions and carry-forwards: event, from/to quantity, reason, note, user and time), the plan's source warehouses, incoming supply at those warehouses (open purchase and manufacturing orders, with the nearest ETA in days), and whether the product is a kit or manufactured — useful for deciding how to close a shortfall.

Required scope: send-plans:read

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

Authentication: Bearer Personal Access Token with the send-plans:read scope. The token's user also needs permission to view the send planner.

incoming[].ref_type identifies the kind of supply document (purchase order or manufacturing order) and ref_id its ID.

lines[].events[].user_name is the name of the user behind each event (null for system events).

production (manufactured products and kits only; null otherwise): what Plan Production for Send Plan Product would put on the Master Production Schedule — quantity (the shortfall), need_by (Y-m-d) with need_by_reason, the suggested warehouse_id and the plan's source warehouse_options, send_plan_line_id (the most-short line), and existing (production demand the planner already raised for this product: id, warehouse_id, warehouse_name, bucket_start, quantity, send_plan_id, send_plan_line_id). When the product is not short but demand was raised earlier, quantity is 0 and only existing is filled.

Returns 404 when the product is not in the plan.

Request​

Responses​

OK

Response Headers
    Content-Type