Inbound Data Model

Every kind of data you can load into GAINS has its own inbound endpoint. This page describes each one: what it represents in GAINS, which fields identify a record, which fields are required, how records nest, and the rules GAINS Connect checks before it accepts a record. Read it when you map your own data to GAINS Connect for the first time.

The API Reference lists every field with its type and maximum length. This page covers what the reference does not make obvious. How a batch is accepted and tracked is described in Inbound Endpoints & Integration Tasks.

How to read this page

Each subject has a short table:

Rules common to every subject:

• The format of a date depends on the field; the API Reference gives each field's format. See Dates and times.
• Field names, value types and the 400 for an unknown field are described in Data Formats & Conventions.
• Where a subject accepts ExtendedData, see Extended Data - Inbound.

🚧

Some dates are required although the API Reference shows them as optional

GAINS Connect rejects a record without these dates: RequestDate and OrderEntryDate on usage transactions, and PromiseDate and OrderReleaseDate on their lines; EffectiveFrom on bill of material components; GeneratedOn on imported forecasts; StartDate and EndDate on weekly and monthly calendar overrides, and ModifiedSchedule on daily ones; and on deletes, CustomerRequestDate for demand transactions, OrderReleaseDate for usage transactions and EffectiveFrom for bills of material.

Master data

SKUs

An item in the GAINS item master, independent of where it is stocked.

Locations

A distribution center, warehouse, branch or other place where items are planned or stocked.

SKU-locations

An item at a location, the level at which GAINS forecasts and plans inventory.

Customers

A customer and one of its ship-to destinations.

Vendors

A supplier, optionally specific to the location that receives from it.

Sourcing and product structure

Vendor alternatives

The vendors that can supply an item at a location, with their costs, lead times and production capacity.

Vendor constraints

Purchase order minimums, maximums and lead times that apply to a vendor.

Partner vendor parameters

Vendor costs, capacity and price breaks for an item, sent by a partner. See Introduction to Partner APIs.

Bills of material

The components that make up a kit at the location where it is assembled.

Supercessions

A new SKU-location that replaces one or more old ones.

SKU-location alternatives

A SKU-location that can be substituted for another, with the cost of substituting and of transporting it.

Price breaks

Quantity discounts and expediting costs for a SKU-location.

Inventory

Inventory availability

On-hand and unshipped quantities of an item at each location.

Inventory lots

On-hand quantity of an item by lot, at each location.

Transactions

Demand transactions

Sales order lines, both shipped history and open orders.

OrderNumber is optional on the load but required to delete. Send it, with LineNumber, on every transaction you may need to delete later.

A header carries values its lines share; a line overrides them where it differs:

[
  {
    "IdealShipFromLocationCode": "CHI01",
    "ActualShipFromLocationCode": "CHI01",
    "CustomerRequestDate": "2026-05-22",
    "OrderEntryDate": "2026-05-18",
    "OrderNumber": "SO-100482",
    "CustomerShipToCode": "ST-01",
    "CustomerCode": "C-10452",
    "LineItems": [
      {
        "ItemCode": "ASM-7701",
        "RequestedQuantity": 40,
        "ShippedQuantity": 40,
        "SalesPrice": 18.75,
        "LineNumber": "1",
        "OrderType": 0,
        "Status": "03"
      },
      {
        "ItemCode": "ASM-7702",
        "CustomerRequestDate": "2026-05-29",
        "RequestedQuantity": 12,
        "LineNumber": "2",
        "OrderType": 0,
        "Status": "00"
      }
    ]
  }
]

Demand events

Promotions and other events that change demand for SKU-locations over a period.

Supply transactions

Purchase, transfer and work order lines: what is on order and what has been received.

POST /supply-transactions/link-order records the number your own system gave to an order that GAINS generated. It takes one object, not an array: the GAINS TrackingNumber and your ExternalOrderId, both required. It creates no task and answers 202 with no body; a request that fails its checks answers 400.

Usage transactions

Components consumed by work orders.

Work order components

The kits a work order assembles and the components each kit consumes.

Planning inputs

Imported forecasts

A monthly forecast you produce outside GAINS, per SKU-location.

Leading indicator inputs

Values of an external indicator, by period, that GAINS uses in leading indicator analysis.

Calendar overrides

Exceptions to a location's working calendar: days it does, or does not, receive, ship, produce, release or deliver.

[
  {
    "LocationCode": "CHI01",
    "OverrideType": "E",
    "Description": "No Saturday receiving June to August",
    "StartDate": "2026-06-01",
    "EndDate": "2026-08-31",
    "ModifiedSchedule": ["saturday"],
    "AppliesTo": ["receive", "delivery"]
  }
]

Custom data

Data that fits none of the subjects above can be loaded through a custom schema that GAINS sets up for you. See Custom Schema.

Related guides

• Inbound Endpoints & Integration Tasks: responses, tasks and task statuses.
• Rejected Records: reading RejectedRecords and RecordKey.
• Load Throughput & Retries: batch sizing and retrying safely.