Class ExternalFulfillmentReturnsApiClient

ExternalFulfillmentReturnsApi - object-oriented interface

Hierarchy (View Summary)

ExternalFulfillmentReturnsApi
- ExternalFulfillmentReturnsApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getReturn listReturns

Constructors

constructor

new ExternalFulfillmentReturnsApiClient(
configuration: ClientConfiguration,
): ExternalFulfillmentReturnsApiClient
Parameters
- configuration: ClientConfiguration
Returns ExternalFulfillmentReturnsApiClient
Overrides ExternalFulfillmentReturnsApi.constructor
- Defined in client.ts:8

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getReturn

getReturn(
requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Return, any, {}>>
Retrieve the return item with the specified ID.
Parameters
- requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Return, any, {}>>
Throws
Inherited from ExternalFulfillmentReturnsApi.getReturn
- Defined in api-model/api/external-fulfillment-returns-api.ts:328

listReturns

listReturns(
requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ReturnsResponse, any, {}>>
Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
Parameters
- requestParameters: ExternalFulfillmentReturnsApiListReturnsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ReturnsResponse, any, {}>>
Throws
Inherited from ExternalFulfillmentReturnsApi.listReturns
- Defined in api-model/api/external-fulfillment-returns-api.ts:338