Function VendorOrdersApiFp

Returns {
    getPurchaseOrder(
        purchaseOrderNumber: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrderResponse>,
    >;
    getPurchaseOrders(
        limit?: number,
        createdAfter?: string,
        createdBefore?: string,
        sortOrder?: GetPurchaseOrdersSortOrderEnum,
        nextToken?: string,
        includeDetails?: boolean,
        changedAfter?: string,
        changedBefore?: string,
        poItemState?: "Cancelled",
        isPOChanged?: boolean,
        purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum,
        orderingVendorCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrdersResponse>,
    >;
    getPurchaseOrdersStatus(
        limit?: number,
        sortOrder?: GetPurchaseOrdersStatusSortOrderEnum,
        nextToken?: string,
        createdAfter?: string,
        createdBefore?: string,
        updatedAfter?: string,
        updatedBefore?: string,
        purchaseOrderNumber?: string,
        purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum,
        itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum,
        itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum,
        orderingVendorCode?: string,
        shipToPartyId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrdersStatusResponse>,
    >;
    submitAcknowledgement(
        body: SubmitAcknowledgementRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitAcknowledgementResponse>,
    >;
}

• getPurchaseOrder:function

  • getPurchaseOrder(
        purchaseOrderNumber: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrderResponse>,
    >

  • Returns a purchase order based on the purchaseOrderNumber value 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • purchaseOrderNumber: string

      The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPurchaseOrders:function

  • getPurchaseOrders(
        limit?: number,
        createdAfter?: string,
        createdBefore?: string,
        sortOrder?: GetPurchaseOrdersSortOrderEnum,
        nextToken?: string,
        includeDetails?: boolean,
        changedAfter?: string,
        changedBefore?: string,
        poItemState?: "Cancelled",
        isPOChanged?: boolean,
        purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum,
        orderingVendorCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrdersResponse>,
    >

  • Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • Optionallimit: number

      The limit to the number of records returned. Default value is 100 records.
    • OptionalcreatedAfter: string

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

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

      Sort in ascending or descending order by purchase order creation date.
    • OptionalnextToken: string

      Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
    • OptionalincludeDetails: boolean

      When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
    • OptionalchangedAfter: string

      Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalchangedBefore: string

      Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalpoItemState: "Cancelled"

      Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
    • OptionalisPOChanged: boolean

      When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
    • OptionalpurchaseOrderState: GetPurchaseOrdersPurchaseOrderStateEnum

      Filters purchase orders based on the purchase order state.
    • OptionalorderingVendorCode: string

      Filters purchase orders based on the specified ordering vendor code. This value should be same as &#39;sellingParty.partyId&#39; in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPurchaseOrdersStatus:function

  • getPurchaseOrdersStatus(
        limit?: number,
        sortOrder?: GetPurchaseOrdersStatusSortOrderEnum,
        nextToken?: string,
        createdAfter?: string,
        createdBefore?: string,
        updatedAfter?: string,
        updatedBefore?: string,
        purchaseOrderNumber?: string,
        purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum,
        itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum,
        itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum,
        orderingVendorCode?: string,
        shipToPartyId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPurchaseOrdersStatusResponse>,
    >

  • Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • Optionallimit: number

      The limit to the number of records returned. Default value is 100 records.
    • OptionalsortOrder: GetPurchaseOrdersStatusSortOrderEnum

      Sort in ascending or descending order by purchase order creation date.
    • OptionalnextToken: string

      Used for pagination when there are more purchase orders than the specified result size limit.
    • OptionalcreatedAfter: string

      Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalcreatedBefore: string

      Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalupdatedAfter: string

      Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalupdatedBefore: string

      Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
    • OptionalpurchaseOrderNumber: string

      Provides purchase order status for the specified purchase order number.
    • OptionalpurchaseOrderStatus: GetPurchaseOrdersStatusPurchaseOrderStatusEnum

      Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
    • OptionalitemConfirmationStatus: GetPurchaseOrdersStatusItemConfirmationStatusEnum

      Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.
    • OptionalitemReceiveStatus: GetPurchaseOrdersStatusItemReceiveStatusEnum

      Filters purchase orders based on the purchase order&#39;s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.
    • OptionalorderingVendorCode: string

      Filters purchase orders based on the specified ordering vendor code. This value should be same as &#39;sellingParty.partyId&#39; in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.
    • OptionalshipToPartyId: string

      Filters purchase orders for a specific buyer&#39;s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as &#39;shipToParty.partyId&#39; in the purchase order. If not included in filter, this will return purchase orders for all the buyer&#39;s warehouses used for vendor group purchase orders.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • body: SubmitAcknowledgementRequest

      Submits acknowledgements for one or more purchase orders from a vendor.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws