Load SKU-Location data

post

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

Loads SKU-location data into GAINS X; one record is one SKU stocked at one location, identified by ItemCode and LocationCode, with its planning parameters. 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

ItemCode

string

required

length between 1 and 65

Part number or Item/SKU code

LocationCode

string

required

length between 1 and 80

Location code (DC, warehouse, etc.) where SKU is planned, forecasted, or stocked

Department

string

length between 0 and 8

Top-level product hierarchy or item grouping code

Group

string

length between 0 and 12

Sub-level product hierarchy or item grouping code

Description

string

length between 0 and 80

Item description

InventoryClass

string

length between 0 and 4

Inventory classification flag (Ex. A, B, C)

DistributionLevel

int32

Distribution level

SellingPrice

double

≥ 0

Unit selling price to customers per item

StandardCost

double

≥ 0

Unit cost for inventory valuation

FOBCost

double

≥ 0

Standard cost minus the cost of in-bound freight (and possibly other overhead). This cost is used in GAINS' ORQ calculation.

Weight

double

≥ 0

Item weight

Volume

double

≥ 0

Cubic Volume Ft

OnHand

int32

≥ 0

Current On Hand Qty

UnshippedQty

int32

Quantity of item that is unshipped from the location

PLBConversionFactor

double

≥ 0

Package units, Conversion factor of converting to an alternate unit of measure

MaxORQInWeeks

double

≥ 0

Maximum ordering quantity (expressed in weeks of inventory on hand)

LeadTime

double

≥ 0

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

ServiceLevel

double

≥ 0

Targeted % of customer orders filled complete and on-time

ReceivingCost

double

≥ 0

Cost to receive an order from a vendor or internal supplier, or to manufacture in-house

CarryingCost

double

≥ 0

Cost associated with holding an item in inventory

PriceBreakPointer

int32

≥ 0

Identifier of the price break table that applies to this SKU-location

FreightBreakPointer

int32

≥ 0

Identifier of the freight break table that applies to this SKU-location

MinimumORQ

int32

≥ 0

Minimum order quantity

IncrementalORQ

int32

≥ 0

Incremental order quantity (order quantities must be in multiples of this value)

StockIndicator

string

length between 0 and 1

Flag used for designating forecast only records (not stocked) or for cross-docking hubs

CurrentSSMinROP

int32

≥ 0

The currently-used Safety Stock or, where applicable, the value for triggering an order

CurrentOQMax

int32

≥ 0

The current order quantity or, where applicable, the order-up-to quantity

ParentCode

string

length between 0 and 80

Vendor number OR parent warehouse/distribution center code. Overrides LocationCode when provided

ParentAllocation

int32

Percentage sourced from parent

ItemType

string

length between 0 and 1

Item classification. Used to distinguish stock from non-stock & consumable from rotable parts

ReserveStockQuantityRSQ

int32

≥ 0

Amount of inventory that will be considered reserved stock for contingency/special purposes (acts as a minimum on hand)

RSQApplication

int32

≥ 0

Processing options 3 = applies larger quantity of SS or RSQ; 2 = subtracts RSQ in addition to SS; 1 = deducts RSQ at beginning of PIPE in addition to SS at LT

Planner

string

length between 0 and 12

Person responsible for planning the SKUL

HistoryBeginDate

date

Allows removal of historical values from consideration for forecasts (YYYY-MM-DD)

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