Load demand side transactions

post

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

Loads demand transactions (sales orders) into GAINS X; one record is one order with its LineItems. Header values apply to every line; a value sent on a line overrides it for that line. 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

IdealShipFromLocationCode

string

length between 0 and 80

Location where Item is ordered/ideally shipped from. Required here unless it is supplied on every line item

ActualShipFromLocationCode

string

length between 0 and 80

Location where item is actually shipped from. If absent, will assume ideal location

CustomerRequestDate

date

Date customer requests an order for item to be shipped (YYYY-MM-DD). Required here unless it is supplied on every line item

OrderEntryDate

date

Date order is entered for item to be processed (YYYY-MM-DD)

OrderNumber

string

length between 0 and 80

Unique assigned sales order number

CustomerShipToCode

string

length between 0 and 80

Used if customer requires item to be shipped to a certain location

CustomerCode

string

length between 0 and 22

Name/code of customer placing the order. Not required unless channel forecasting is in play

CustomerCodeDescription

string

length between 0 and 80

Customer name/code description

OrderFulfillCost

int32

Total cost of demand transaction line to fill the order

OrderRevenueCost

int32

Total revenue received from the order

Channel

string

length between 0 and 80

Channel code that represents a slice of customers or region so that demand can be attributed to that specific cohort

LotNumber

string

length between 0 and 20

Used for lot specific demand

SalesOrderComments

string

length between 0 and 100

Header level comments for the sales order

LineItems

array of objects

required

length ≥ 1

The line items belonging to this demand transaction

LineItems*

The line items belonging to this demand transaction

ItemCode

string

required

length between 1 and 65

Part number or item/SKU code

IdealShipFromLocationCode

string

length between 0 and 80

(Line Override) Location where Item is ordered/ideally shipped from. Overrides the header value; required on every line when the header does not supply it

ActualShipFromLocationCode

string

length between 0 and 80

(Line Override) Location where item is actually shipped from. If absent, will assume ideal location

CustomerRequestDate

date

(Line Override) Date customer requests an order for item to be shipped (YYYY-MM-DD). Overrides the header value; required on every line when the header does not supply it

OrderFulfillCost

int32

(Line Override) Total cost of demand transaction line to fill the order

OrderRevenueCost

int32

(Line Override) Total revenue received from the order

LotNumber

string

length between 0 and 20

(Line Override) Used for lot specific demand

ItemDescription

string

length between 0 and 80

Description of line item

PromiseDate

date

Date order for item is promised to the customer (YYYY-MM-DD)

OrderReleaseDate

date

Date order for item is released from manufacturing and ready for distribution (YYYY-MM-DD)

OrderShipDate

date

Date order for item is shipped to customer (YYYY-MM-DD)

RequestedQuantity

int32

required

Customer requested quantity for item in units

ShippedQuantity

int32

Actual ship quantity for item in units

SalesPrice

double

Unit price for item

LineNumber

string

length between 0 and 8

Line number assigned per line

LineComment

string

Free-text note recorded against this line item

BTOKitItemCode

string

length between 0 and 65

Build-to-Order (BTO) kit item code

BTOKitLocationCode

string

length between 0 and 80

Build-to-Order (BTO) kit location code

OrderType

int32

enum

0 to 4

'0' for Standard/recurring; '1' for Project/Non-Recurring; '2' for Disposition/Non-Recurring Sale; '3' for Build/Buy-to-Order (BTO) Sales; '4' for Unconfirmed Project Order

Allowed:

ActualItemNumber

string

length between 0 and 65

Item name or reference

Status

string

enum

length between 0 and 2

'00' for planned, '03' for closed, '04' for cancelled

Allowed:

ExcludeFlag

boolean

Set to true to exclude this line from processing and forecasting

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.

ExtendedData

object

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