Load SKU data

post

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

Loads SKU (item) master data into GAINS X; one record is one SKU, identified by ItemCode. 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

ItemType

string

length between 0 and 1

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

Description

string

required

length between 1 and 80

Item description

Department

string

required

length between 1 and 8

Top-level product hierarchy or item grouping code

Group

string

required

length between 1 and 12

Sub-level product hierarchy or item grouping code

Planner

string

length between 0 and 12

Person responsible for planning the SKUL

PrimaryVendorCode

string

length between 0 and 80

The vendor code that is primarily associated with this SKU

PrimaryVendorLeadTime

int32

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

StockingUnitOfMeasure

string

length between 0 and 4

E.g., EA, LBS, FT

Weight

double

Item weight

WeightUnitOfMeasure

string

length between 0 and 4

Weight ISO Code (E.g., LBR, KGM, etc.)

Volume

double

Cubic Volume Ft

VolumeUnitOfMeasure

string

length between 0 and 4

Volume ISO Code (E.g., INQ, FTQ, MTQ, etc.)

ServiceLevel

float

Targeted % of customer orders filled complete and on-time

ShelfLife

int32

Amount of weeks item can be held without expiring (also surplus time limit)

StandardCost

double

Unit cost for inventory valuation

ReceivingCost

double

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

CarryingCost

double

Cost associated with holding an item in inventory

FixedModel

int32

Manually set GAINS forecast model override

MinimumORQ

int32

Minimum order quantity

IncrementalORQ

int32

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

InventoryClass

string

length between 0 and 4

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

ItemCreateDate

date

Inception date or date item was initially stocked (YYYY-MM-DD)

RSQApplication

int32

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

LifeOfTypeIndicator

int32

Indicator that final order was placed for this SKUL (life-time buy)

SeasonStartDate

date

Start date of season (YYYY-MM-DD)

SeasonEndDate

date

End date of season (YYYY-MM-DD)

ItemLaunchDate

date

Planned/actual date of 1st demand (YYYY-MM-DD)

SkuImageUrl

string

length between 0 and 2048

URL of the SKU Image that will be displayed alongside SKU

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