Run Template

The Run Template API allows you to run one or more Replenishment Templates (configured in the Replenishment Template UI) to generate replenishment waves.

API URLs

Lookup by Template ID

POST.../entity/replenishment_template/{id}/run_template/

• No additional parameters are required in the request body.

Lookup by Filters

POST.../entity/replenishment_template/run_template/

Parameters

Field	Type	Required	Description
facility_id	integer	No	Facility context by id.
facility_id__code	string	No	Facility context by code.
template_name	string	Yes	Replenishment Template Name to run.

If more than one template matches the filters, the API returns an error.

Options

Field	Type	Required	Description
company_id	integer	No	Company context by id.
company_code	string	No	Company context by code.

options.company_id/company_code sets the user’s company context corresponding to the wave template’s facility to ensure correct company parameters are applied. If omitted, the user’s default company context is used.

Sample request payload (Lookup by Filters)

{
  "parameters": {
    "facility_id": "1",
    "template_name": "REP_WAVE_TEMPLATE_1"
  },
  "options": {
    "company_code": "COMP1"
  }
}