Load price break data

post

https://{env}.gainsystems.com/api/v1/price-breaks

Loads price breaks into GAINS X; one record is one SKU-location with its ordering parameters and its PriceBreaks. 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 (e.g., DC, warehouse) where the price break is applied

DelayPercent

double

0 to 1

Percentage delayed resulting in lost sales (range 0-1, e.g., 0.10 for 10%)

ExpeditePerOrder

double

0 to 1

Percentage of receiving cost required for expediting an order (range 0-1)

ExpediteCost

double

Direct costs required for expediting an order

LineOrdersPriorYear

int32

Total number of orders placed for a particular item from last year

AvgOrderSize

int32

Average order quantity for a particular item from last year

MaxUnitsOrq

int32

Maximum order quantity in units

MinWeeksOrq

int32

Minimum number of weeks ORQ

PriceBreaks

array of objects

required

length ≥ 1

List of price break rules for the item

PriceBreaks*

List of price break rules for the item

Break

int32

required

1 to 5

Price break number, 1 to 5. The breaks of one PriceBreaks list are numbered from 1 with no gaps or repeats.

Discount

double

required

0 to 1

Discount factor applied (range 0-1, e.g., 0.95 for a 5% discount)

UnitCost

double

required

Cost per unit

MinOrderQty

int32

required

Minimum quantity required for this price break

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