Skip to main content

Build PO (Forecast)

POST 
/api/purchase-orders/build

Build a suggested purchase order based on sales history or other forecast types.

Authentication: Requires Bearer token.

Required fields:

  • supplier_id (required, exists:suppliers)
  • destination_warehouse_id (required unless forecast_type=sales_history, exists:warehouses)
  • forecast_type (required): in:sales_history,target_stock_level,backorder
  • options (required, array):
    • quantity (required when forecast_type=target_stock_level, numeric, min:0)
    • sales_start_date (required when forecast_type=sales_history, date, before:tomorrow)
    • sales_end_date (required when forecast_type=sales_history, date, after_or_equal sales_start_date)
    • target_stock_days (required when forecast_type=sales_history, integer, min:1)
    • rounding_method (optional): none, ceil, floor, round
    • use_leadtime (optional, boolean)
    • use_moq (optional, boolean)
    • product_filters (optional, array)
    • sales_history_filters (optional, array)

Note: Max 500 products per build request.

Request​

Responses​

Successful response