Home > @vsf-enterprise/commercetools-api > getInventory
# getInventory() function
Endpoint for checking inventory for given product SKUs. By default, it uses the getInventoryDefaultQuery GraphQL query
Signature:
export declare function getInventory(context: Context, params?: GetInventoryParams, customQuery?: CustomQuery): Promise<GetInventoryResponse>;
# Parameters
Parameter | Type | Description |
---|---|---|
context | Context | Automatically injected context. Refer to Context |
params | GetInventoryParams | Inventory search parameters |
customQuery | CustomQuery | Custom queries included in the request |
Returns:
Promise<GetInventoryResponse>
Inventory data