Class ExternalFulfillmentLocationApi

ExternalFulfillmentLocationApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- ExternalFulfillmentLocationApi
  - ExternalFulfillmentLocationApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

createSandboxLocation

Constructors

constructor

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

createSandboxLocation

createSandboxLocation(
requestParameters: ExternalFulfillmentLocationApiCreateSandboxLocationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateSandboxLocationResponse, any, {}, any>>
Creates a sandbox location and merchant in the test environment. This operation is available only in the sandbox environment and is used for onboarding test locations. Idempotency is ensured on locationName.
Parameters
- requestParameters: ExternalFulfillmentLocationApiCreateSandboxLocationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateSandboxLocationResponse, any, {}, any>>

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