import type * as Square from "../index"; export interface BatchRetrieveInventoryChangesRequest { /** * The filter to return results by `CatalogObject` ID. * The filter is only applicable when set. The default value is null. */ catalogObjectIds?: string[] | null; /** * The filter to return results by `Location` ID. * The filter is only applicable when set. The default value is null. */ locationIds?: string[] | null; /** * The filter to return results by `InventoryChangeType` values other than `TRANSFER`. * The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. */ types?: Square.InventoryChangeType[] | null; /** * The filter to return `ADJUSTMENT` query results by * `InventoryState`. This filter is only applied when set. * The default value is null. */ states?: Square.InventoryState[] | null; /** * The filter to return results with their `calculated_at` value * after the given time as specified in an RFC 3339 timestamp. * The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). */ updatedAfter?: string | null; /** * The filter to return results with their `created_at` or `calculated_at` value * strictly before the given time as specified in an RFC 3339 timestamp. * The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). */ updatedBefore?: string | null; /** * A pagination cursor returned by a previous call to this endpoint. * Provide this to retrieve the next set of results for the original query. * * See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. */ cursor?: string | null; /** The number of [records](entity:InventoryChange) to return. */ limit?: number | null; /** * Specification of how returned inventory changes should be ordered. * * Currently, inventory changes can only be ordered by the occurred_at field. * The default sort order for occurred_at is ASC (changes are returned oldest-first by default). */ sort?: Square.BatchRetrieveInventoryChangesSort; /** * The filter to return `ADJUSTMENT` query results by inventory * adjustment reason. This filter is only applied when set. The request cannot * include both `reason_ids` and `states`. */ reasonIds?: Square.InventoryAdjustmentReasonId[] | null; }