Retrieve demand forecast as weekly buckets

get

https://{env}.gainsystems.com/api/v1/demand-planning/forecast/weekly

Returns the GAINS forecast in weekly buckets, one record per item with a forecast for each of its locations; an item's locations can continue on the next page. See Forecasts & Demand History.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ItemCode

string

Return only forecasts for these items. Up to 10 values, comma-separated with no spaces; each must match exactly.

LocationCode

string

Return only forecasts for these locations. Up to 10 values, comma-separated with no spaces; each must match exactly.

Period

int32

Number of buckets to return per item/location, from the first forecast period. Weekly: 1 to 104, default 52. Monthly and monthly-aggregate: 1 to 24, default 12

StockIndicator

string

Return only item/locations with these stock indicators. Up to 10 values, comma-separated with no spaces; each must match exactly.

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

ExtendedDataFilters

object

Filters on extended-data attributes. Send each as its own query parameter named by the attribute's ApiLabel, for example ?Region=EMEA. Only attributes configured with IsAvailableAsQueryParam can be used (see GET /api/v1/extended-data); each takes a single exact value, and a standard attribute that is not text is ignored. Unrecognised query parameters are ignored.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

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

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

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