Glossary

The terms the GAINS Connect guides use, in alphabetical order. Each links to the page that explains it.

Term	Meaning
API label	The name an extended data attribute is sent and returned under, set up for your environment. See Extended Data.
Approval code	The approval status of an order or requisition line. Order endpoints return approved orders unless you name other codes. See Replenishment Orders.
Bill of material	The components that make up a kit at the location where it is assembled. See Sourcing & Product Structure.
Custom schema	A route GAINS sets up for you to submit and read data that fits none of the standard endpoints. See Custom Schema.
`DataType`	The value in every outbound response and webhook payload that names the kind of records it carries, such as `purchase_order`. See Outbound Subjects.
Environment	One GAINS installation, with its own GAINS Connect address, credentials and data. See Getting Started.
Extended data	Attributes of your own carried alongside the standard fields of a record, under `ExtendedData`. See Extended Data.
GAINS	The supply chain planning platform covering demand planning, inventory optimization and replenishment. See Getting Started.
GAINS Connect	The REST API for exchanging planning data between your systems and GAINS. See Getting Started.
GAINS X	The GAINS application your environment runs, which GAINS Connect loads data into and reads it from. Some endpoints need a minimum GAINS X version. See GAINS Versions & Availability.
Idempotency key	A value you send in the `Idempotency-Key` header so that a resent batch is not loaded twice. See Idempotency.
Integration task	The record GAINS Connect creates for every accepted submit or delete, tracking it until GAINS has finished loading it. See Integration Tasks.
Inventory class	A classification of SKU-locations, such as `A` or `B`, that inventory policies carry and can be filtered by. See Inventory Policies.
Inventory policy	The order quantity, safety stock and service level GAINS calculated for a SKU-location. See Inventory Policies.
Item	A product in the GAINS item master, identified by `ItemCode`; also called a SKU. See Master Data.
Location	A distribution center, warehouse, branch, plant or other place where items are planned or stocked, identified by `LocationCode`. See Master Data.
Maintenance window	The daily period during which GAINS planning data cannot be read and most read endpoints answer `503`. See GAINS Versions & Availability.
Model run	One training of the lead-time prediction model, named by its `ModelRunDate`. See Lead-Time Prediction.
`Orq`	Order quantity, in inventory policy fields such as `CalcOrq` and `AdjustedOrq`. See Inventory Policies.
Partner	A supplier a GAINS customer has authorized to submit data about the items it supplies. See Partner APIs.
Price break	A quantity discount for a SKU-location, numbered from `1`. See Sourcing & Product Structure.
Receiving location	The location an order or requisition delivers into. See Replenishment Orders.
Rejected record	A record of a submit that failed validation or that GAINS refused while loading, reported with its reason. See Rejected Records.
Requisition	A single order recommendation in GAINS: one item to be ordered from one shipping location into one receiving location. See Replenishment Orders.
`Rsq`	Reserve stock quantity, in inventory policy fields such as `Rsq` and `RsqOverride`. See Inventory Policies.
Service level	The service level target behind an inventory policy. GAINS evaluates several per SKU-location and reports the order quantity, safety stock and costs each would bring. See Inventory Policies.
Ship-to	One delivery destination of a customer, identified by `ShipToCode`. A customer with several ship-to addresses has one record for each. See Master Data.
Shipping location	The location an order or requisition is shipped from. See Replenishment Orders.
SKU	An item in the GAINS item master, independent of where it is stocked. See Master Data.
SKU-location	An item at a location: the level at which GAINS forecasts and plans inventory. See Master Data.
`Ss`	Safety stock, in inventory policy fields such as `CalcSs` and `AdjustedSs`. See Inventory Policies.
Stock indicator	A code on a SKU-location's inventory policy saying whether it is stocked, for example `S` for stocked. See Inventory Policies.
Supercession	A new SKU-location that replaces one or more old ones. See Sourcing & Product Structure.
Task type	The `TaskType` of an integration task, naming the endpoint it came from, such as `InboundLocation`. See Integration Tasks.
Tracking number	The `TrackingNumber` that groups requisitions into an order once a buyer submits them. See Replenishment Orders.
Trigger	The kind of event a webhook reports, such as `POSubmit` or `InventoryPolicyUpdate`. See Webhooks.
Webhook configuration	A destination URL with its triggers, filters, authorization and delivery settings. See Configuring Webhooks.

Getting Started
Inbound Subjects: what you can send
Outbound Subjects: what you can read

Related