You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getInventory
Endpoint for checking inventory for given product SKUs. By default, it uses the getInventoryDefaultQuery GraphQL query
Signature
export declare function getInventory(
context: SetupContext,
params?: GetInventoryParams,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<GetInventoryResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Optional | GetInventoryParams | Inventory search parameters |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Inventory data