API Reference

Load demand side transactions with split level line items

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

Loads demand transactions whose lines are split across several deliveries into GAINS X; one record is one order with its LineItems, each carrying its SplitItems. 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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 0 and 80

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

string
length between 0 and 80

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

date

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

date

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

string
length between 0 and 80

Unique assigned sales order number

string
length between 0 and 80

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

string
length between 0 and 22

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

string
length between 0 and 80

Customer name/code description

int32

Total cost of demand transaction line to fill the order

int32

Total revenue received from the order

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

string
length between 0 and 20

Used for lot specific demand

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

string
required
length between 1 and 65

Part number or item/SKU code

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

string
length between 0 and 80

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

int32

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

int32

(Line Override) Total revenue received from the order

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

string
length between 0 and 80

Description of line item

double

Unit price for item

string
required
length between 0 and 8

Line number assigned per line; must be unique within the payload

string

Optional line level comment

string
length between 0 and 65

Build-to-Order (BTO) kit item code

string
length between 0 and 80

Build-to-Order (BTO) kit location code

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:
string
length between 0 and 65

Item name or reference

boolean

Set to true to exclude this line from processing and forecasting

SplitItems
array of objects
required
length ≥ 1

Split level detail for the line item; cannot be empty

SplitItems*

Split level detail for the line item; cannot be empty

string
required
length between 0 and 24

Unique identifier for the split within the line item

string
length between 0 and 20

Lot number for the split

date

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

date

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

date

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

date

The date the customer requested this split quantity for (YYYY-MM-DD)

int32
required

Customer requested quantity for item in units

int32

Actual ship quantity for item in units

string
length between 0 and 2

'00' for planned, '03' for closed, '04' for cancelled (2 character maximum)

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

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
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?