Function VendorDFSandboxApiFp

VendorDFSandboxApi - functional programming interface

Export

  • VendorDFSandboxApiFp(
        configuration?: Configuration,
    ): {
        generateOrderScenarios(
            body: GenerateOrderScenarioRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        getOrderScenarios(
            transactionId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionStatus>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        generateOrderScenarios(
            body: GenerateOrderScenarioRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        getOrderScenarios(
            transactionId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionStatus>,
        >;
    }

    • generateOrderScenarios:function
      • generateOrderScenarios(
            body: GenerateOrderScenarioRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

      • Submits a request to generate test order data for Vendor Direct Fulfillment API entities.

        Parameters

        • body: GenerateOrderScenarioRequest

          The request payload containing parameters for generating test order data scenarios.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        Throws

    • getOrderScenarios:function
      • getOrderScenarios(
            transactionId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionStatus>,
        >

      • Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.

        Parameters

        • transactionId: string

          The transaction identifier returned in the response to the generateOrderScenarios operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionStatus>,
        >

        Throws

Settings

Member Visibility