Load location reference data

post

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

Loads location master data into GAINS X; one record is one location, identified by LocationCode. 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

LocationCode

string

required

length between 1 and 80

The code associated with the location

Name

string

length between 0 and 100

The name of the location

Type

string

required

length between 1 and 65

The type of the location

ParentDefaultCode

string

length between 0 and 80

The default code of the parent location

Address1

string

length between 0 and 40

First line of the address

Address2

string

length between 0 and 40

Second line of the address

City

string

length between 0 and 40

The city where the location is situated

State

string

length between 0 and 40

The region or state where the location is situated

Country

string

length between 0 and 30

The country where the location is situated

PostalCode

string

length between 0 and 15

The postal or ZIP code of the location

Latitude

double

-90 to 90

The latitude coordinate of the location

Longitude

double

-180 to 180

The longitude coordinate of the location

StartDate

date

The start date for the availability of the location (YYYY-MM-DD)

EndDate

date

The end date for the availability of the location (YYYY-MM-DD)

Size

string

length between 0 and 80

The size of the location

CurrencyCode

string

length between 0 and 50

The currency code associated with the location

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