Load supercession relationships

post

https://{env}.gainsystems.com/api/v1/supercessions

Loads supercession relationships into GAINS X; one record is one new (superseding) item with the old items it replaces. Records that pass validation are loaded asynchronously; follow the returned task. See Sourcing & Product Structure.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

NewItem

object

required

The item that supersedes the old items

OldItems

array of objects

required

length ≥ 1

The items superseded by the new item; none may have the same ItemCode and LocationCode as NewItem

OldItems*

The items superseded by the new item; none may have the same ItemCode and LocationCode as NewItem

ItemCode

string

required

length between 1 and 65

The code of the old item being superseded

LocationCode

string

required

length between 1 and 80

Location code where the old item is located

CopyPercent

double

Percentage of history that is copied over from the old item to the new item

OnHandRollupIndicator

boolean

Flag to indicate if the inventory of the superseded item should be incorporated into the effective on-hand of the superseding item

Documentation

string

length between 0 and 227

Brief explanation or notes on why the item is being superseded

FixedModel

int32

Manually set forecast model override for the item at the specified location

SupercessionType

int32

Flag indicating whether the history of the superseded item should be moved or copied to the superseding item

EffectiveDate

string

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

Date and time when the supercession takes effect. Format: YYYY-MM-DD HH:MM:SS

SuptransRollup

boolean

Whether supply transactions for the old item roll up to the new item

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