Outbound Subjects

Every kind of data you can read from GAINS has its own outbound endpoint. This page lists them, grouped by the page that describes them: what each returns, its DataType, whether the subject also arrives by webhook, and whether it carries extended data. To choose between reading an endpoint and receiving a webhook, see Pull or Push.

Every endpoint returns DataType, Data and Paging, and takes Size and Cursor; see Pagination. The custom schema data endpoint is the exception: it returns Data and Paging only. A webhook delivery carries the same DataType and Data, without Paging. A Yes in the Webhook column means the subject also arrives by webhook; Webhooks lists the trigger of each. The API Reference describes every parameter and field.

Replenishment Orders

See Replenishment Orders.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /replenishment/purchase-orders`	Submitted purchase orders, with their lines	`purchase_order`	Yes	Yes
`GET /replenishment/transfer-orders`	Submitted transfer orders, with their lines	`transfer_order`	Yes	Yes
`GET /replenishment/work-orders`	Submitted work orders, with their lines	`work_order`	Yes	Yes
`GET /replenishment/production-orders`	Submitted production orders, with their lines	`production_order`	Yes	Yes
`GET /replenishment/requisitions`	Order recommendations, one line per record	`requisition`	No	Yes

Forecasts & Demand History

See Forecasts & Demand History.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /demand-planning/forecast/weekly`	Weekly forecast buckets per SKU-location	`forecast`	Yes	Yes
`GET /demand-planning/forecast/monthly`	Monthly forecast buckets per SKU-location	`forecast`	Yes	Yes
`GET /demand-planning/forecast/monthly-aggregate`	Monthly aggregate forecast per SKU-location	`forecast`	No	Yes
`GET /demand-planning/demand-history`	Demand transaction lines	`demand_history`	No	Yes

Inventory Policies

See Inventory Policies.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /inventory/policies`	The inventory policy of each SKU-location	`inventory_policy`	Yes	Yes
`GET /inventory/service-level`	Policies with their costs and the service levels GAINS evaluated	`inventory_service_level`	No	Yes

Master Data & Product Structure

See Master Data & Product Structure.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /locations`	Your locations	`location`	No	Yes
`GET /vendors`	Your vendors, with lead times and ordering terms	`vendor`	No	No
`GET /customers`	Your customers and their ship-to addresses	`customer`	No	No
`GET /inventory/bills-of-material`	The components of each kit, per kit location	`bill_of_material`	No	No
`GET /inventory/supercessions`	Each superseding SKU-location with the SKU-locations it replaces	`supercessions`	No	No

Lead-Time Prediction

See Lead-Time Prediction. These endpoints are available only when lead-time prediction is enabled for your environment.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /ltp/predictions`	The predicted lead time of each SKU-location	`prediction`	No	No
`GET /ltp/predictions/features`	What contributed to one SKU-location's prediction	`predictions_features`	No	No
`GET /ltp/models/training`	Model metrics on the training data	`training`	No	No
`GET /ltp/models/holdout`	Model metrics on the holdout data	`holdout`	No	No
`GET /ltp/features/predictions`	Training feature values	`training_predictions`	No	No
`GET /ltp/features/probability`	Training probability feature values	`training_probability`	No	No
`GET /ltp/features/evaluations`	Holdout evaluation feature values	`holdout_evaluation_features`	No	No

Custom Schema

See Custom Schema.

Endpoint	Returns	`DataType`	Webhook	Extended data
`GET /custom/{ApiRoute}`	The records you loaded into a custom schema, for a route your GAINS representative has set up	None	No	No

Access

Bearer clients are granted access per group: replenishment (orders and requisitions), demand planning (forecasts and demand history), inventory optimization (policies, service levels, bills of material and supercessions), master data (locations, vendors and customers), lead-time prediction, and custom data. Basic users can read every group. Ask your GAINS representative to change what your client can read.

Errors

Outbound endpoints return the statuses described in Errors & Retries. Two are specific to reading data:

Status	Cause
`403 Forbidden`	On a lead-time prediction endpoint: lead-time prediction is not enabled for your environment. The reason says the service is not available.
`426 Upgrade Required`	The GAINS X your environment is connected to is too old for this endpoint. The response says which version is required. See GAINS Versions & Availability.

Pull or Push: choosing between an endpoint and a webhook
Webhooks: trigger names and setup
Pagination
Receiving Extended Data: extended data on outbound records, and filtering by it
Errors & Retries