getAvailability

Get SKU availability by location, by group, or by both.

Calls the skuAvailabilityByLocationAndOrGroup endpoint exposed by SCAPI. *

Signature

export declare function getAvailability(
	props: AvailabilityGetParams
): Promise<AvailabilityGetResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`AvailabilityGetParams`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.

Returns

Returns a representation of an item's availability information.

Referenced Types

AvailabilityGetParams
AvailabilityGetResponse

Examples

Getting SKU availability by location.

import { sdk } from '~/sdk.config.ts';

const data: AvailabilityGetParams = {
  skus: ['productSku'],
  locations: ['warehouse5']
};

const result = await sdk.commerce.getAvailability(data);

Getting SKU availability by group.

import { sdk } from '~/sdk.config.ts';

const data: AvailabilityGetParams = {
  skus: ['productSku'],
  groups: ['US']
};

const result = await sdk.commerce.getAvailability(data);