Function OrdersApiFp

Returns {
    getOrder(
        orderId: string,
        includedData?: GetOrderIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderResponse>,
    >;
    searchOrders(
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        fulfillmentStatuses?: SearchOrdersFulfillmentStatusesEnum[],
        marketplaceIds?: string[],
        fulfilledBy?: SearchOrdersFulfilledByEnum[],
        maxResultsPerPage?: number,
        paginationToken?: string,
        includedData?: SearchOrdersIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchOrdersResponse>,
    >;
}

• getOrder: function

  • getOrder(
        orderId: string,
        includedData?: GetOrderIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderResponse>,
    >

    Returns the order that you specify.

    Parameters

    • orderId: string

      An Amazon-defined order identifier.

    • OptionalincludedData: GetOrderIncludedDataEnum[]

      A list of datasets to include in the response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• searchOrders: function

  • searchOrders(
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        fulfillmentStatuses?: SearchOrdersFulfillmentStatusesEnum[],
        marketplaceIds?: string[],
        fulfilledBy?: SearchOrdersFulfilledByEnum[],
        maxResultsPerPage?: number,
        paginationToken?: string,
        includedData?: SearchOrdersIncludedDataEnum[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchOrdersResponse>,
    >

    Returns orders that are created or updated during the time period that you specify. You can filter the response for specific types of orders.

    Parameters

    • OptionalcreatedAfter: string

      The response includes orders created at or after this time. The date must be in ISO 8601 format. Note: You must provide exactly one of `createdAfter` and `lastUpdatedAfter` in your request. If `createdAfter` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.

    • OptionalcreatedBefore: string

      The response includes orders created at or before this time. The date must be in ISO 8601 format. Note: If you include `createdAfter` in the request, `createdBefore` is optional, and if provided must be equal to or after the `createdAfter` date and at least two minutes before the time of the request. If `createdBefore` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.

    • OptionallastUpdatedAfter: string

      The response includes orders updated at or after this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format. Note: You must provide exactly one of `createdAfter` and `lastUpdatedAfter`. If `lastUpdatedAfter` is provided, neither `createdAfter` nor `createdBefore` may be provided.

    • OptionallastUpdatedBefore: string

      The response includes orders updated at or before this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format. Note: If you include `lastUpdatedAfter` in the request, `lastUpdatedBefore` is optional, and if provided must be equal to or after the `lastUpdatedAfter` date and at least two minutes before the time of the request. If `lastUpdatedBefore` is provided, neither `createdAfter` nor `createdBefore` may be provided.

    • OptionalfulfillmentStatuses: SearchOrdersFulfillmentStatusesEnum[]

      A list of `FulfillmentStatus` values you can use to filter the results.

    • OptionalmarketplaceIds: string[]

      The response includes orders that were placed in marketplaces you include in this list. Refer to Marketplace IDs for a complete list of `marketplaceId` values.

    • OptionalfulfilledBy: SearchOrdersFulfilledByEnum[]

      The response includes orders that are fulfilled by the parties that you include in this list.

    • OptionalmaxResultsPerPage: number

      The maximum number of orders that can be returned per page. The value must be between 1 and 100. Default: 100.

    • OptionalpaginationToken: string

      Pagination occurs when a request produces a response that exceeds the `maxResultsPerPage`. This means that the response is divided into individual pages. To retrieve the next page, you must pass the `nextToken` value as the `paginationToken` query parameter in the next request. You will not receive a `nextToken` value on the last page.

    • OptionalincludedData: SearchOrdersIncludedDataEnum[]

      A list of datasets to include in the response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws