Load demand side events

post

https://{env}.gainsystems.com/api/v1/demand-events

Loads demand events into GAINS X; one record is one event, identified by EventId, with the SKU-locations it affects. 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

EventId

int64

required

Unique identifier for the event

Name

string

length between 0 and 65

Name of the event

Description

string

length between 0 and 200

Detailed description of the event

Type

int32

Numeric code classifying the demand event

TypeDescription

string

length between 0 and 10

Description of the event type code

StartDate

date

Start date of the event (YYYY-MM-DD)

EndDate

date

End date of the event (YYYY-MM-DD); must be on or after StartDate

Details

array of objects

Additional details about the event

Details

ExtendedData

object

Customer-defined extended data attributes for this record, keyed by the API label configured for the payload (see GET /api/v1/extended-data). Labels configured as required must be present. If no extended data is configured for this payload, a record carrying ExtendedData is rejected.

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