Function VendorOrdersApiFp

VendorOrdersApi - functional programming interface

Export

  • VendorOrdersApiFp(
        configuration?: Configuration,
    ): {
        getOrder(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrderResponse>,
        >;
        getOrders(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            status?: GetOrdersStatusEnum,
            limit?: number,
            sortOrder?: GetOrdersSortOrderEnum,
            nextToken?: string,
            includeDetails?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrdersResponse>,
        >;
        submitAcknowledgement(
            body: SubmitAcknowledgementRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitAcknowledgementResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getOrder(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrderResponse>,
        >;
        getOrders(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            status?: GetOrdersStatusEnum,
            limit?: number,
            sortOrder?: GetOrdersSortOrderEnum,
            nextToken?: string,
            includeDetails?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrdersResponse>,
        >;
        submitAcknowledgement(
            body: SubmitAcknowledgementRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitAcknowledgementResponse>,
        >;
    }

    • getOrder:function
      • getOrder(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrderResponse>,
        >

      • Returns purchase order information for the purchaseOrderNumber that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • purchaseOrderNumber: string

          The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getOrders:function
      • getOrders(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            status?: GetOrdersStatusEnum,
            limit?: number,
            sortOrder?: GetOrdersSortOrderEnum,
            nextToken?: string,
            includeDetails?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetOrdersResponse>,
        >

      • Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • createdAfter: string

          Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.

        • createdBefore: string

          Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.

        • OptionalshipFromPartyId: string

          The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.

        • Optionalstatus: GetOrdersStatusEnum

          Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.

        • Optionallimit: number

          The limit to the number of purchase orders returned.

        • OptionalsortOrder: GetOrdersSortOrderEnum

          Sort the list in ascending or descending order by order creation date.

        • OptionalnextToken: string

          Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.

        • OptionalincludeDetails: boolean

          When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • submitAcknowledgement:function
      • submitAcknowledgement(
            body: SubmitAcknowledgementRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitAcknowledgementResponse>,
        >

      • Submits acknowledgements for one or more purchase orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • body: SubmitAcknowledgementRequest

          The request body containing the acknowledgement to an order.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility