Issue a new forecast
How to issue a forecast as a buyer
As buyer you can send a new forecast to your supplier.
A forecast cannot be updated. Issued forecasts will always be appended to the existing set of forecasts.
The forecast module is under development. The API and documentation may change.
Send new forecast by buyer
When sending a forecast the provided supplier account number will be verified.
Response status codes:
- 200 OK - the supplier account number exists and the forecast will be processed.
- 202 Accepted - the supplier verification has been skipped due to service unavailability and the forecast has been queued.
- 404 Not Found - the supplier account number has not been found.
companyId: the optional Tradecloud company identifier. You only have to provide a companyId when your integration user account has authorization for multiple companies.
supplierAccountNumber: the supplier account number as known in your ERP system.
supplierAccountNumbermust be set in the Tradecloud connection in the portal, after the connection request has been accepted.
forecastNumber: the mandatory forecast identifier, like code or number as known in your forecast or ERP system. The number must be the same for all items for all suppliers in the same generated forecast.
forecastNumbermust not contain whitespace characters.
lines: a forecast contains one or multiple lines. A forecast line consists of an item and forecast schedule. It is structured as a JSON element in the
lines.item: the forecasted item (or article, goods).
buyerItemNumber: the mandatory item code or number as known in your ERP system.
buyerItemRevision: the revision (or version) of this item number.
buyerItemName: the mandatory item short name.
supplierItemNumber: the item code or number as known at the supplier. Required in case of wholesale suppliers.
purchaseUnitOfMeasureIso: the purchase unit according to ISO 80000-1, a typical example is
buyerItemNumbershould be unique within your company and never change. Never renumber or re-use
lines.schedule: the forecast schedule lines for this item, each consisting of a forecast period and forecasted demand during this period. It is structured as a JSON element in the
startDate: the first day of this forecast period. Date has ISO 8601 date
yyyy-MM-ddformat. See also Standards.
endDate: the last day of this forecast period.
quantity: the forecasted demand of this item, in this period, for this supplier. Quantity has a decimal
1234.56format with any number of digits.
issueDateTime: Date and time the forecast was originally issued in your forecast or ERP system.
DateTimehas ISO 8601 local date/time format
yyyy-MM-ddThh:mm:ss. See also Standards.