Function OrdersApiFp

Returns {
    confirmShipment(
        orderId: string,
        payload: ConfirmShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getOrder(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderResponse>,
    >;
    getOrderAddress(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderAddressResponse>,
    >;
    getOrderBuyerInfo(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderBuyerInfoResponse>,
    >;
    getOrderItems(
        orderId: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderItemsResponse>,
    >;
    getOrderItemsBuyerInfo(
        orderId: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderItemsBuyerInfoResponse>,
    >;
    getOrderRegulatedInfo(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderRegulatedInfoResponse>,
    >;
    getOrders(
        marketplaceIds: string[],
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        orderStatuses?: string[],
        fulfillmentChannels?: string[],
        paymentMethods?: string[],
        buyerEmail?: string,
        sellerOrderId?: string,
        maxResultsPerPage?: number,
        easyShipShipmentStatuses?: string[],
        electronicInvoiceStatuses?: string[],
        nextToken?: string,
        amazonOrderIds?: string[],
        actualFulfillmentSupplySourceId?: string,
        isISPU?: boolean,
        storeChainStoreId?: string,
        earliestDeliveryDateBefore?: string,
        earliestDeliveryDateAfter?: string,
        latestDeliveryDateBefore?: string,
        latestDeliveryDateAfter?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrdersResponse>,
    >;
    updateShipmentStatus(
        orderId: string,
        payload: UpdateShipmentStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateVerificationStatus(
        orderId: string,
        payload: UpdateVerificationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• confirmShipment: function

  • confirmShipment(
        orderId: string,
        payload: ConfirmShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates the shipment confirmation status for a specified order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • payload: ConfirmShipmentRequest

      Request body of `confirmShipment`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrder: function

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

    Returns the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderAddress: function

  • getOrderAddress(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderAddressResponse>,
    >

    Returns the shipping address for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      The Amazon order identifier in 3-7-7 format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderBuyerInfo: function

  • getOrderBuyerInfo(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderBuyerInfoResponse>,
    >

    Returns buyer information for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      The Amazon order identifier in 3-7-7 format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderItems: function

  • getOrderItems(
        orderId: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderItemsResponse>,
    >

    Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • OptionalnextToken: string

      A string token returned in the response of your previous request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderItemsBuyerInfo: function

  • getOrderItemsBuyerInfo(
        orderId: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderItemsBuyerInfoResponse>,
    >

    Returns buyer information for the order items in the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • OptionalnextToken: string

      A string token returned in the response of your previous request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderRegulatedInfo: function

  • getOrderRegulatedInfo(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderRegulatedInfoResponse>,
    >

    Returns regulated information for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      The Amazon order identifier in 3-7-7 format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrders: function

  • getOrders(
        marketplaceIds: string[],
        createdAfter?: string,
        createdBefore?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        orderStatuses?: string[],
        fulfillmentChannels?: string[],
        paymentMethods?: string[],
        buyerEmail?: string,
        sellerOrderId?: string,
        maxResultsPerPage?: number,
        easyShipShipmentStatuses?: string[],
        electronicInvoiceStatuses?: string[],
        nextToken?: string,
        amazonOrderIds?: string[],
        actualFulfillmentSupplySourceId?: string,
        isISPU?: boolean,
        storeChainStoreId?: string,
        earliestDeliveryDateBefore?: string,
        earliestDeliveryDateAfter?: string,
        latestDeliveryDateBefore?: string,
        latestDeliveryDateAfter?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrdersResponse>,
    >

    Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. NextToken doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceIds: string[]

      A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to Marketplace IDs for a complete list of `marketplaceId` values.

    • OptionalcreatedAfter: string

      Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format. Note: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.

    • OptionalcreatedBefore: string

      Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. Note: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.

    • OptionallastUpdatedAfter: string

      Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. Note: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.

    • OptionallastUpdatedBefore: string

      Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. Note: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.

    • OptionalorderStatuses: string[]

      A list of `OrderStatus` values used to filter the results. Possible values: - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)

    • OptionalfulfillmentChannels: string[]

      A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).

    • OptionalpaymentMethods: string[]

      A list of payment method values. Use this field to select orders that were paid with the specified payment methods. Possible values: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).

    • OptionalbuyerEmail: string

      The email address of a buyer. Used to select orders that contain the specified email address.

    • OptionalsellerOrderId: string

      An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.

    • OptionalmaxResultsPerPage: number

      A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.

    • OptionaleasyShipShipmentStatuses: string[]

      A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. Possible values: - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)

    • OptionalelectronicInvoiceStatuses: string[]

      A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. Possible values: - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)

    • OptionalnextToken: string

      A string token returned in the response of your previous request.

    • OptionalamazonOrderIds: string[]

      A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.

    • OptionalactualFulfillmentSupplySourceId: string

      The `sourceId` of the location from where you want the order fulfilled.

    • OptionalisISPU: boolean

      When true, this order is marked to be picked up from a store rather than delivered.

    • OptionalstoreChainStoreId: string

      The store chain store identifier. Linked to a specific store in a store chain.

    • OptionalearliestDeliveryDateBefore: string

      Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format.

    • OptionalearliestDeliveryDateAfter: string

      Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format.

    • OptionallatestDeliveryDateBefore: string

      Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format.

    • OptionallatestDeliveryDateAfter: string

      Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateShipmentStatus: function

  • updateShipmentStatus(
        orderId: string,
        payload: UpdateShipmentStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Update the shipment status for an order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • payload: UpdateShipmentStatusRequest

      The request body for the `updateShipmentStatus` operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateVerificationStatus: function

  • updateVerificationStatus(
        orderId: string,
        payload: UpdateVerificationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates (approves or rejects) the verification status of an order containing regulated products. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      The Amazon order identifier in 3-7-7 format.

    • payload: UpdateVerificationStatusRequest

      The request body for the `updateVerificationStatus` operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws