Class ExternalFulfillmentInventoryApi

ExternalFulfillmentInventoryApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- ExternalFulfillmentInventoryApi
  - ExternalFulfillmentInventoryApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new ExternalFulfillmentInventoryApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ExternalFulfillmentInventoryApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ExternalFulfillmentInventoryApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

batchInventory

batchInventory(
requestParameters: ExternalFulfillmentInventoryApiBatchInventoryRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BatchInventoryResponse, any, {}, any>>
Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the inventory count for the provided sku and locationId pair.
Parameters
- requestParameters: ExternalFulfillmentInventoryApiBatchInventoryRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BatchInventoryResponse, any, {}, any>>

Throws
- Defined in api-model/api/external-fulfillment-inventory-api.ts:131