Retrieve predicted lead times

get

https://{env}.gainsystems.com/api/v1/ltp/predictions

Returns the lead times a model run predicted, one record per item and location. ModelRunDate must match a model run exactly, and no endpoint lists the runs: ask your GAINS representative for them. See Lead-Time Prediction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ItemCode

string

Return the prediction for this item. Must be sent together with LocationCode; omit both to return every item/location. A single code, not a list.

LocationCode

string

Return the prediction for this location. Must be sent together with ItemCode; omit both to return every item/location. A single code, not a list.

ModelRunDate

string

required

The model run to return predictions from, as a timestamp (YYYY-MM-DD HH:MM:SS). Must match a model run's timestamp exactly; a timestamp with no run returns no records.

Cursor

string

Opaque cursor identifying the page to return. Omit for the first page, then pass the NextCursor value from the previous response

Size

integer

1 to 1000

Defaults to 100

Maximum number of records to return in one page, from 1 to 1000. Default 100. On endpoints that group records under an item (for example, policies and forecasts), the limit applies to item/location records, so a page can return fewer top-level items than Size

Responses

200Request succeeded

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

500Unexpected server error

503GAINS is temporarily unavailable: GAINS X could not be reached or returned an error, a scheduled GAINS process is running, or your credentials could not be checked. Retry later

504GAINS X did not respond in time. Retry later