Function OrdersApiFactory

Returns {
    confirmShipment(
        requestParameters: OrdersApiConfirmShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getOrder(
        requestParameters: OrdersApiGetOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderResponse>;
    getOrderAddress(
        requestParameters: OrdersApiGetOrderAddressRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderAddressResponse>;
    getOrderBuyerInfo(
        requestParameters: OrdersApiGetOrderBuyerInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderBuyerInfoResponse>;
    getOrderItems(
        requestParameters: OrdersApiGetOrderItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderItemsResponse>;
    getOrderItemsBuyerInfo(
        requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
    getOrderRegulatedInfo(
        requestParameters: OrdersApiGetOrderRegulatedInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrderRegulatedInfoResponse>;
    getOrders(
        requestParameters: OrdersApiGetOrdersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetOrdersResponse>;
    updateShipmentStatus(
        requestParameters: OrdersApiUpdateShipmentStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateVerificationStatus(
        requestParameters: OrdersApiUpdateVerificationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• confirmShipment: function

  • confirmShipment(
        requestParameters: OrdersApiConfirmShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiConfirmShipmentRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getOrder: function

  • getOrder(
        requestParameters: OrdersApiGetOrderRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderResponse>

    Throws

• getOrderAddress: function

  • getOrderAddress(
        requestParameters: OrdersApiGetOrderAddressRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderAddressRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderAddressResponse>

    Throws

• getOrderBuyerInfo: function

  • getOrderBuyerInfo(
        requestParameters: OrdersApiGetOrderBuyerInfoRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderBuyerInfoRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderBuyerInfoResponse>

    Throws

• getOrderItems: function

  • getOrderItems(
        requestParameters: OrdersApiGetOrderItemsRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderItemsRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderItemsResponse>

    Throws

• getOrderItemsBuyerInfo: function

  • getOrderItemsBuyerInfo(
        requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderItemsBuyerInfoResponse>

    Throws

• getOrderRegulatedInfo: function

  • getOrderRegulatedInfo(
        requestParameters: OrdersApiGetOrderRegulatedInfoRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrderRegulatedInfoRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrderRegulatedInfoResponse>

    Throws

• getOrders: function

  • getOrders(
        requestParameters: OrdersApiGetOrdersRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiGetOrdersRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetOrdersResponse>

    Throws

• updateShipmentStatus: function

  • updateShipmentStatus(
        requestParameters: OrdersApiUpdateShipmentStatusRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiUpdateShipmentStatusRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updateVerificationStatus: function

  • updateVerificationStatus(
        requestParameters: OrdersApiUpdateVerificationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: OrdersApiUpdateVerificationStatusRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws