Load vendor alternatives for SKUs and vendor parameters

post

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

Loads the vendors able to supply each SKU-location into GAINS X; one record is one SKU-location with its list of Vendors. Records that pass validation are loaded asynchronously; follow the returned task. See Sourcing & Product Structure.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

Vendors

array of objects

required

length ≥ 1

The vendors able to supply this item and location

Vendors*

The vendors able to supply this item and location

SupplierCode

string

required

length between 1 and 80

The code identifying the vendor/supplier

SupplierType

string

enum

^(|M|P)$

Acceptable values are M (Manufactured) or P (Purchased) or empty

Allowed:

MinimumOrq

int32

Minimum order quantity for item

IncrementalOrq

int32

Incremental order quantity for item

StandardCost

double

Unit cost

ReceivingCost

double

Cost to receive item to warehouse from manufacturer or production facility

LeadTime

double

Time in weeks (typically time to manufacture item and/or obtain item in-house for distribution)

LeadTimeVariance

int32

Lead time variance

YieldVariance

double

Yield % variance

UnitRehandlingCost

double

Rehandling cost per unit

UnitTransportationCost

double

From hub to child transportation cost per unit

ProductionLine

string

required

length between 1 and 80

Represents a specific production line or manufacturing process within a facility

CapacityAllocGroup

string

required

length between 1 and 65

Grouping SKULs to allow for streamlined production

CapacityUnits

double

Unit production rate

SetupTime

double

Time taken to set up production

Breakpoints

object

Quantity breakpoints at which the vendor's costs change

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

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