Load BOM data

post

https://{env}.gainsystems.com/api/v1/bills-of-material

Loads bills of material into GAINS X; one record is one kit item with, for each location it is assembled at, the components it consumes. 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

KitItemCode

string

required

length between 1 and 65

Item code of the kit (the end item being assembled or repaired)

KitLocations

array of objects

required

length ≥ 1

The locations the kit is assembled at

KitLocations*

The locations the kit is assembled at

KitLocationCode

string

required

length between 1 and 80

Location Code/Number where the kit is assembled

Components

array of objects

required

length ≥ 1

The components consumed to assemble the kit at this location

Components*

The components consumed to assemble the kit at this location

ComponentItemCode

string

required

length between 1 and 65

Item code of the component used to assemble the kit item

ComponentLocationCode

string

required

length between 1 and 80

Location code where the component is from

ComponentQty

double

required

Number of component items that are used to make the kit

ComponentYield

double

Percent of the components issued to the kit order that are typically usable

EffectiveFrom

date

required

Required. BOM effective from date (YYYY-MM-DD)

EffectiveTo

date

BOM effective to date (YYYY-MM-DD)

PhantomFlag

boolean

Whether the component is a phantom assembly, planned through rather than stocked

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