API Reference

Link a supply transaction to a generated PO/TO/WO

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

Records the identifier a recommended order received in your own system against its GAINS tracking number. The link is sent to GAINS during the request: no task is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required
≥ 0

The GAINS tracking number of the supply transaction to link

string
required
length between 0 and 80

The identifier the order carries in the customer's own system

string
length between 0 and 256

Free-text note to record against the link

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
202

The link was accepted by GAINS. The response has no body

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?