Load vendor parameters and purchase order constraints

post

https://{env}.gainsystems.com/api/v1/vendor-constraints

Loads vendor purchase order constraints into GAINS X; one record is one vendor, optionally at one receiving location, with its order constraint. Each submit replaces the whole set: constraints missing from the request are removed, so send the complete set in one request. Records that pass validation are loaded asynchronously; follow the returned task. See Sourcing & Product Structure.

GAINS X version requirement:

Min: 10.0-ER2609

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

VendorCode

string

required

length between 1 and 80

The code identifying the vendor/supplier, as it appears in the item master

VendorDescription

string

length between 0 and 80

Description of the vendor/supplier

ReceiveLocationCode

string

length between 0 and 80

The code of the receiving location the constraint applies to, as it appears in the item master. Defaults to ALL when omitted.

VendorParent

string

length between 0 and 8

Parent of the listed vendors, for which several vendors may appear on one purchase order

VendorCategorizing

string

length between 0 and 4

Groups under one constraint key every record that can be used to meet a single constraint

VendorType

int32

1 to 3

1 = inventory vendor, 2 = vendor managed inventory (VMI), 3 = consignment vendor. Defaults to 1.

POConstraintFamily

string

length between 0 and 12

High-level family that groups like product groups under a common vendor and purchase order constraint

POQuantity

double

required

The constraint quantity, for example a minimum billing amount. When POType is 4, 5 or 6 this is a lead time in days rather than a quantity.

POUnitOfMeasure

int32

required

1 to 4

Unit of the purchase order minimum: 1 = cost, 2 = units, 3 = cubage, 4 = weight. Ignored when POType is 4, 5 or 6.

POType

int32

required

1 to 6

The type of purchase order minimum: 1 = minimum quantity, 2 = maximum quantity, 3 = exact quantity. 4, 5 and 6 instead set the pre-order, post-receipt and supplier lead time from POQuantity and create no constraint.

POIntegrity

int32

required

1 to 2

The level of adherence at which the restriction must be met: 1 = firm (for example a buying level minimum), 2 = soft (for example a freight level minimum). Ignored when POType is 4, 5 or 6.

POCostLimit

double

The maximum carrying cost that recommended orders outside lead time may incur in order to meet a purchase order minimum. Defaults to 0.

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