API Reference

Load SKUL forecast data

post
https://{env}.gainsystems.com/api/v1/forecasts

Loads imported forecasts into GAINS X; one record is one item with, for each location, its monthly forecast values. Records that pass validation are loaded asynchronously; follow the returned task. See Demand Planning.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 65

Unique identifier for the item

Locations
array of objects
required
length ≥ 1

List of locations associated with the forecasts

Locations*

List of locations associated with the forecasts

string
required
length between 1 and 80

Unique identifier for the location

string
required
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Required. Date and time the forecast was generated. Format: YYYY-MM-DD HH:MM:SS

string
length between 0 and 8

Channel identifier

ForecastBuckets
array of objects
required
length between 12 and 2147483647

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

ForecastBuckets*

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
≥ 0

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Between 12 and 24 monthly forecast values for the item at this location, one per ForecastPeriodNumber

int32
required
1 to 24

Forecast month, from 1 to 24. A location's periods are numbered from 1 with no gaps, and each may appear only once

int32
required
0 to 2147483647

Forecast value for the specified period

Headers
string
length ≤ 255

Optional key that makes a retry safe. A request repeating a key already used on this endpoint within the last 24 hours is refused with 400 and nothing is submitted again. A UUID is recommended; at most 255 characters

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 3 months ago

Did this page help you?