Retrieve BOM relationships

get

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

Returns bill-of-material relationships: the component items each kit item consumes, at each location it is assembled at. See Master Data & Product Structure.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

KitItemCode

string

Return only bills of material for these kit items. Up to 10 values, comma-separated with no spaces; each must match exactly.

KitLocationCode

string

Return only bills of material for kits assembled at these locations. Up to 10 values, comma-separated with no spaces; each must match exactly.

ItemLocationFilterType

string

include (default) returns only records matching the KitItemCode and KitLocationCode filters. exclude returns only records matching neither. Case-insensitive; any other value is rejected with 400.

Cursor

string

Opaque cursor identifying the page to return. Omit for the first page, then pass the NextCursor value from the previous response

Size

integer

1 to 1000

Defaults to 100

Maximum number of records to return in one page, from 1 to 1000. Default 100. On endpoints that group records under an item (for example, policies and forecasts), the limit applies to item/location records, so a page can return fewer top-level items than Size

Headers

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

200Request succeeded

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

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

500Unexpected server error

503GAINS is temporarily unavailable: GAINS X could not be reached or returned an error, a scheduled GAINS process is running, or your credentials could not be checked. Retry later

504GAINS X did not respond in time. Retry later