Class VendorDirectFulfillmentSandboxTestDataApi

VendorDirectFulfillmentSandboxTestDataApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- VendorDirectFulfillmentSandboxTestDataApi
  - VendorDirectFulfillmentSandboxTestDataApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

generateOrderScenarios getOrderScenarios

Constructors

constructor

new VendorDirectFulfillmentSandboxTestDataApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): VendorDirectFulfillmentSandboxTestDataApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns VendorDirectFulfillmentSandboxTestDataApi
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

generateOrderScenarios

generateOrderScenarios(
requestParameters: VendorDirectFulfillmentSandboxTestDataApiGenerateOrderScenariosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionReference, any, {}, any>>
Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
Parameters
- requestParameters: VendorDirectFulfillmentSandboxTestDataApiGenerateOrderScenariosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionReference, any, {}, any>>

Throws
- Defined in api-model/api/vendor-direct-fulfillment-sandbox-test-data-api.ts:197

getOrderScenarios

getOrderScenarios(
requestParameters: VendorDirectFulfillmentSandboxTestDataApiGetOrderScenariosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionStatus, any, {}, any>>
Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.
Parameters
- requestParameters: VendorDirectFulfillmentSandboxTestDataApiGetOrderScenariosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionStatus, any, {}, any>>

Throws
- Defined in api-model/api/vendor-direct-fulfillment-sandbox-test-data-api.ts:207