Load vendor master and reference data

post

https://{env}.gainsystems.com/api/v1/vendors

Loads vendor master data into GAINS X; one record is one vendor, identified by VendorCode, either at one receiving location (ReceiveLocationCode) or without one. Records that pass validation are loaded asynchronously; follow the returned task. See Master Data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

VendorCode

string

required

length between 1 and 80

The unique code assigned to the vendor

Name

string

required

length between 1 and 40

The name of the vendor

FullName

string

length between 0 and 60

The full name of the vendor

ReceiveLocationCode

string

length between 0 and 80

The code indicating the receiving location

BuyerCode

string

length between 0 and 12

The code assigned to the buyer

Address1

string

length between 0 and 40

First line of the vendor's address

Address2

string

length between 0 and 40

Second line of the vendor's address

Address3

string

length between 0 and 40

Third line of the vendor's address

City

string

length between 0 and 40

The city where the vendor is located

State

string

length between 0 and 40

The region or state where the vendor is located

Country

string

length between 0 and 15

The country where the vendor is located

PostalCode

string

length between 0 and 15

The postal or ZIP code of the vendor's location

Latitude

string

length ≤ 40

The latitude coordinate of the vendor's location, -90 to 90

Longitude

string

length ≤ 40

The longitude coordinate of the vendor's location, -180 to 180

string

length between 0 and 60

The email address of the vendor

Fax

string

length between 0 and 20

The fax number of the vendor

Phone

string

length between 0 and 20

The phone number of the vendor

ContactName

string

length between 0 and 20

The name of the primary contact person at the vendor

FreightTerms

string

length between 0 and 40

The freight terms associated with the vendor

Fob

string

length between 0 and 20

The FOB (Free On Board) terms associated with the vendor

ShipMethod

string

length between 0 and 20

The shipping method used by the vendor

CreditTerms

string

length between 0 and 40

The credit terms offered by the vendor

SubmitMethod

string

length between 0 and 40

The method used to submit orders to the vendor

LeadTimeVendor

float

≥ 0

The lead time for vendor processing

LeadTimePreorder

float

≥ 0

The lead time for pre-order processing

LeadTimePostorder

double

≥ 0

Post-receipt lead time: time from receipt until the stock is available

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