Load supply side transactions (excludes split/delivery data)

post

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

Loads supply transactions (purchase, transfer and work 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. Orders whose lines are split across dates or statuses go to POST /api/v1/supply-transactions-splits. Records that pass validation are loaded asynchronously; follow the returned task. See Inventory & Supply.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

OrderNumber

string

required

length between 1 and 80

Order number identifying PO, TO or WO

SupplierCode

string

length between 0 and 80

Vendor number or parent warehouse/distribution center code. Required here unless it is supplied on every line item

OriginalOrderCreateDate

date

required

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

InvoiceNumber

int32

≥ 0

Supplier/vendor invoice number for supply transaction

SupplierReferenceNumber

string

length between 0 and 65

Supplier/vendor tracking number for the order

TrackingNumber

string

length between 0 and 9

The GAINS tracking number of the order (up to 9 characters)

LineItems

array of objects

required

length ≥ 1

The line items belonging to this supply transaction

LineItems*

The line items belonging to this supply transaction

LineNumber

string

required

length between 1 and 8

Line specific number

ItemCode

string

required

length between 1 and 65

Part number or Item/SKU code

LocationCode

string

required

length between 1 and 80

Location code or number

ExpectedReceiveDate

date

Date the order is expected to be received (YYYY-MM-DD)

ActualReceiveDate

date

Date order is actually received to stock and ready for processing (YYYY-MM-DD)

OriginalRequestQuantity

int32

≥ 0

Quantity of item requested in units

PostInspectionReceiveQuantity

int32

≥ 0

Quantity of item actually received in units

Status

string

enum

required

length between 1 and 2

'00' for planned, '01' for in-transit, '02' for in-process, '03' for closed, '04' for cancelled

Allowed:

ExternalOrderStatus

string

length between 1 and 2

The order status as held in the customer's own system

ExternalSupplyStatus

string

length between 1 and 2

The supply status as held in the customer's own system

SupplierCode

string

length between 0 and 80

(Line Override) Vendor number or parent warehouse/distribution center code. Overrides the header value; required on every line when the header does not supply it

InvoiceNumber

int32

≥ 0

(Line Override) Supplier/vendor invoice number for supply transaction

SupplierReferenceNumber

string

length between 0 and 65

(Line Override) Supplier/vendor tracking number for the order

UnitCostOnOrder

double

≥ 0

Unit cost

ReceivedAtDock

date

Date received at dock for clients that wish to differentiate when an item reaches the dock versus when it is in stock (YYYY-MM-DD)

ComponentDetails

object

The kit and component this line belongs to, for a work order line

Doc

string

length between 0 and 39

Additional notes

LotNo

string

length between 0 and 20

Lot specific supply

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

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