Load monthly leading indicator inputs

post

https://{env}.gainsystems.com/api/v1/lia-input/monthly

Loads monthly leading indicator inputs into GAINS X; one record is one item with, for each location, a leading indicator variable and its value per month. Records that pass validation are loaded asynchronously; follow the returned task. See Demand Planning.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ItemCode

string

required

length between 1 and 65

Item code

Locations

array of objects

required

length ≥ 1

The locations the leading indicator inputs are supplied for

Locations*

The locations the leading indicator inputs are supplied for

LocationCode

string

required

length between 1 and 80

Location code

Channel

string

length between 0 and 12

The sales or distribution channel

VariableName

string

required

length between 1 and 65

Name of the leading indicator variable

Inputs

array of objects

required

length ≥ 1

The leading indicator values for this item and location, one entry per period

Inputs*

The leading indicator values for this item and location, one entry per period

BucketNumber

int32

required

1 to 36

Period number, from 1 to 36

Quantity

double

required

Value of the leading indicator for that period

Headers

Idempotency-Key

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

Language

URL

Loading…

Response

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

*/*

application/json

202Accepted; poll the returned task for progress

207Partially accepted; rejected records are listed in the response

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

422Nothing was accepted and no task was created. Either every record failed validation, and the body lists each one under RejectedRecords with Status "RejectedFailedProcessing"; or the payload was empty or held more than 1000 records, and the body carries a Reason

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

429The service is still ingesting previously submitted data and did not accept this batch. Nothing was persisted; retry the same batch after the interval given in the Retry-After header

500Unexpected server error

503GAINS is temporarily unavailable, or inbound integration is switched off in GAINS X: GAINS X could not be reached or returned an error, or your credentials could not be checked. Retry later, or contact your GAINS representative if inbound integration is not enabled

504GAINS X did not respond in time. Retry later