Retrieve inventory policies

get

https://{env}.gainsystems.com/api/v1/inventory/policies

Returns the current inventory policy of each SKU-location, one record per item with its locations. To receive only the policies that change, use the InventoryPolicyUpdate webhook. See Inventory Policies.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ItemCode

string

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

LocationCode

string

Return only policies for these locations. Up to 10 values, comma-separated with no spaces; each must match exactly.

ItemLocationFilterType

string

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

InventoryClass

string

Return only policies in these inventory classes (e.g., 'A', 'B'). Up to 10 values, comma-separated with no spaces; each must match exactly.

Department

string

Return only policies for these departments. Up to 10 values, comma-separated with no spaces; each must match exactly.

Group

string

Return only policies for these groups. Up to 10 values, comma-separated with no spaces; each must match exactly.

Planner

string

Return only policies for these planners. Up to 10 values, comma-separated with no spaces; each must match exactly.

StockIndicator

string

Return only records with these stock indicators: S (stocked), N (non-stock), C (cross-dock hub), each a single character. Up to 10 values, comma-separated with no spaces; each must match exactly.

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

ExtendedDataFilters

object

Filters on extended-data attributes. Send each as its own query parameter named by the attribute's ApiLabel, for example ?Region=EMEA. Only attributes configured with IsAvailableAsQueryParam can be used (see GET /api/v1/extended-data); each takes a single exact value, and a standard attribute that is not text is ignored. Unrecognised query parameters are ignored.

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