Class OrdersV0Api
- java.lang.Object
-
- software.amazon.spapi.api.orders.v0.OrdersV0Api
-
public class OrdersV0Api extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OrdersV0Api.Builder
-
Field Summary
Fields Modifier and Type Field Description io.github.bucket4j.Bucket
confirmShipmentBucket
io.github.bucket4j.Bucket
getOrderAddressBucket
io.github.bucket4j.Bucket
getOrderBucket
io.github.bucket4j.Bucket
getOrderBuyerInfoBucket
io.github.bucket4j.Bucket
getOrderItemsBucket
io.github.bucket4j.Bucket
getOrderItemsBuyerInfoBucket
io.github.bucket4j.Bucket
getOrderRegulatedInfoBucket
io.github.bucket4j.Bucket
getOrdersBucket
io.github.bucket4j.Bucket
updateVerificationStatusBucket
-
Constructor Summary
Constructors Constructor Description OrdersV0Api(ApiClient apiClient, java.lang.Boolean disableRateLimiting)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
confirmShipment(ConfirmShipmentRequest body, java.lang.String orderId)
Updates the shipment confirmation status for a specified order.okhttp3.Call
confirmShipmentAsync(ConfirmShipmentRequest body, java.lang.String orderId, ApiCallback<java.lang.Void> callback)
(asynchronously) Updates the shipment confirmation status for a specified order.ApiResponse<java.lang.Void>
confirmShipmentWithHttpInfo(ConfirmShipmentRequest body, java.lang.String orderId)
Updates the shipment confirmation status for a specified order.GetOrderResponse
getOrder(java.lang.String orderId)
Returns the order that you specify.GetOrderAddressResponse
getOrderAddress(java.lang.String orderId)
Returns the shipping address for the order that you specify.okhttp3.Call
getOrderAddressAsync(java.lang.String orderId, ApiCallback<GetOrderAddressResponse> callback)
(asynchronously) Returns the shipping address for the order that you specify.ApiResponse<GetOrderAddressResponse>
getOrderAddressWithHttpInfo(java.lang.String orderId)
Returns the shipping address for the order that you specify.okhttp3.Call
getOrderAsync(java.lang.String orderId, ApiCallback<GetOrderResponse> callback)
(asynchronously) Returns the order that you specify.GetOrderBuyerInfoResponse
getOrderBuyerInfo(java.lang.String orderId)
Returns buyer information for the order that you specify.okhttp3.Call
getOrderBuyerInfoAsync(java.lang.String orderId, ApiCallback<GetOrderBuyerInfoResponse> callback)
(asynchronously) Returns buyer information for the order that you specify.ApiResponse<GetOrderBuyerInfoResponse>
getOrderBuyerInfoWithHttpInfo(java.lang.String orderId)
Returns buyer information for the order that you specify.GetOrderItemsResponse
getOrderItems(java.lang.String orderId, java.lang.String nextToken)
Returns detailed order item information for the order that you specify.okhttp3.Call
getOrderItemsAsync(java.lang.String orderId, java.lang.String nextToken, ApiCallback<GetOrderItemsResponse> callback)
(asynchronously) Returns detailed order item information for the order that you specify.GetOrderItemsBuyerInfoResponse
getOrderItemsBuyerInfo(java.lang.String orderId, java.lang.String nextToken)
Returns buyer information for the order items in the order that you specify.okhttp3.Call
getOrderItemsBuyerInfoAsync(java.lang.String orderId, java.lang.String nextToken, ApiCallback<GetOrderItemsBuyerInfoResponse> callback)
(asynchronously) Returns buyer information for the order items in the order that you specify.ApiResponse<GetOrderItemsBuyerInfoResponse>
getOrderItemsBuyerInfoWithHttpInfo(java.lang.String orderId, java.lang.String nextToken)
Returns buyer information for the order items in the order that you specify.ApiResponse<GetOrderItemsResponse>
getOrderItemsWithHttpInfo(java.lang.String orderId, java.lang.String nextToken)
Returns detailed order item information for the order that you specify.GetOrderRegulatedInfoResponse
getOrderRegulatedInfo(java.lang.String orderId)
Returns regulated information for the order that you specify.okhttp3.Call
getOrderRegulatedInfoAsync(java.lang.String orderId, ApiCallback<GetOrderRegulatedInfoResponse> callback)
(asynchronously) Returns regulated information for the order that you specify.ApiResponse<GetOrderRegulatedInfoResponse>
getOrderRegulatedInfoWithHttpInfo(java.lang.String orderId)
Returns regulated information for the order that you specify.GetOrdersResponse
getOrders(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter)
Returns orders that are created or updated during the specified time period.okhttp3.Call
getOrdersAsync(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter, ApiCallback<GetOrdersResponse> callback)
(asynchronously) Returns orders that are created or updated during the specified time period.ApiResponse<GetOrdersResponse>
getOrdersWithHttpInfo(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter)
Returns orders that are created or updated during the specified time period.ApiResponse<GetOrderResponse>
getOrderWithHttpInfo(java.lang.String orderId)
Returns the order that you specify.void
updateVerificationStatus(UpdateVerificationStatusRequest body, java.lang.String orderId)
Updates (approves or rejects) the verification status of an order containing regulated products.okhttp3.Call
updateVerificationStatusAsync(UpdateVerificationStatusRequest body, java.lang.String orderId, ApiCallback<java.lang.Void> callback)
(asynchronously) Updates (approves or rejects) the verification status of an order containing regulated products.ApiResponse<java.lang.Void>
updateVerificationStatusWithHttpInfo(UpdateVerificationStatusRequest body, java.lang.String orderId)
Updates (approves or rejects) the verification status of an order containing regulated products.
-
-
-
Field Detail
-
confirmShipmentBucket
public final io.github.bucket4j.Bucket confirmShipmentBucket
-
getOrderBucket
public final io.github.bucket4j.Bucket getOrderBucket
-
getOrderAddressBucket
public final io.github.bucket4j.Bucket getOrderAddressBucket
-
getOrderBuyerInfoBucket
public final io.github.bucket4j.Bucket getOrderBuyerInfoBucket
-
getOrderItemsBucket
public final io.github.bucket4j.Bucket getOrderItemsBucket
-
getOrderItemsBuyerInfoBucket
public final io.github.bucket4j.Bucket getOrderItemsBuyerInfoBucket
-
getOrderRegulatedInfoBucket
public final io.github.bucket4j.Bucket getOrderRegulatedInfoBucket
-
getOrdersBucket
public final io.github.bucket4j.Bucket getOrdersBucket
-
updateVerificationStatusBucket
public final io.github.bucket4j.Bucket updateVerificationStatusBucket
-
-
Constructor Detail
-
OrdersV0Api
public OrdersV0Api(ApiClient apiClient, java.lang.Boolean disableRateLimiting)
-
-
Method Detail
-
confirmShipment
public void confirmShipment(ConfirmShipmentRequest body, java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- Request body of `confirmShipment`. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
confirmShipmentWithHttpInfo
public ApiResponse<java.lang.Void> confirmShipmentWithHttpInfo(ConfirmShipmentRequest body, java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- Request body of `confirmShipment`. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
confirmShipmentAsync
public okhttp3.Call confirmShipmentAsync(ConfirmShipmentRequest body, java.lang.String orderId, ApiCallback<java.lang.Void> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- Request body of `confirmShipment`. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrder
public GetOrderResponse getOrder(java.lang.String orderId) throws ApiException, LWAException
Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- GetOrderResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderWithHttpInfo
public ApiResponse<GetOrderResponse> getOrderWithHttpInfo(java.lang.String orderId) throws ApiException, LWAException
Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<GetOrderResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderAsync
public okhttp3.Call getOrderAsync(java.lang.String orderId, ApiCallback<GetOrderResponse> callback) throws ApiException, LWAException
(asynchronously) Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrderAddress
public GetOrderAddressResponse getOrderAddress(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- GetOrderAddressResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderAddressWithHttpInfo
public ApiResponse<GetOrderAddressResponse> getOrderAddressWithHttpInfo(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<GetOrderAddressResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderAddressAsync
public okhttp3.Call getOrderAddressAsync(java.lang.String orderId, ApiCallback<GetOrderAddressResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrderBuyerInfo
public GetOrderBuyerInfoResponse getOrderBuyerInfo(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- GetOrderBuyerInfoResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderBuyerInfoWithHttpInfo
public ApiResponse<GetOrderBuyerInfoResponse> getOrderBuyerInfoWithHttpInfo(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<GetOrderBuyerInfoResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderBuyerInfoAsync
public okhttp3.Call getOrderBuyerInfoAsync(java.lang.String orderId, ApiCallback<GetOrderBuyerInfoResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrderItems
public GetOrderItemsResponse getOrderItems(java.lang.String orderId, java.lang.String nextToken) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)- Returns:
- GetOrderItemsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderItemsWithHttpInfo
public ApiResponse<GetOrderItemsResponse> getOrderItemsWithHttpInfo(java.lang.String orderId, java.lang.String nextToken) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)- Returns:
- ApiResponse<GetOrderItemsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderItemsAsync
public okhttp3.Call getOrderItemsAsync(java.lang.String orderId, java.lang.String nextToken, ApiCallback<GetOrderItemsResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrderItemsBuyerInfo
public GetOrderItemsBuyerInfoResponse getOrderItemsBuyerInfo(java.lang.String orderId, java.lang.String nextToken) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)- Returns:
- GetOrderItemsBuyerInfoResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderItemsBuyerInfoWithHttpInfo
public ApiResponse<GetOrderItemsBuyerInfoResponse> getOrderItemsBuyerInfoWithHttpInfo(java.lang.String orderId, java.lang.String nextToken) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)- Returns:
- ApiResponse<GetOrderItemsBuyerInfoResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderItemsBuyerInfoAsync
public okhttp3.Call getOrderItemsBuyerInfoAsync(java.lang.String orderId, java.lang.String nextToken, ApiCallback<GetOrderItemsBuyerInfoResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)nextToken
- A string token returned in the response of your previous request. (optional)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrderRegulatedInfo
public GetOrderRegulatedInfoResponse getOrderRegulatedInfo(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- GetOrderRegulatedInfoResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderRegulatedInfoWithHttpInfo
public ApiResponse<GetOrderRegulatedInfoResponse> getOrderRegulatedInfoWithHttpInfo(java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<GetOrderRegulatedInfoResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrderRegulatedInfoAsync
public okhttp3.Call getOrderRegulatedInfoAsync(java.lang.String orderId, ApiCallback<GetOrderRegulatedInfoResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
getOrders
public GetOrdersResponse getOrders(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter) throws ApiException, LWAException
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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.- Parameters:
marketplaceIds
- A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. (required)createdAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)createdBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)orderStatuses
- 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.) (optional)fulfillmentChannels
- 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). (optional)paymentMethods
- 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). (optional)buyerEmail
- The email address of a buyer. Used to select orders that contain the specified email address. (optional)sellerOrderId
- 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. (optional)maxResultsPerPage
- A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. (optional)easyShipShipmentStatuses
- 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.) (optional)electronicInvoiceStatuses
- 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.) (optional)nextToken
- A string token returned in the response of your previous request. (optional)amazonOrderIds
- A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. (optional)actualFulfillmentSupplySourceId
- The `sourceId` of the location from where you want the order fulfilled. (optional)isISPU
- When true, this order is marked to be picked up from a store rather than delivered. (optional)storeChainStoreId
- The store chain store identifier. Linked to a specific store in a store chain. (optional)earliestDeliveryDateBefore
- Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)earliestDeliveryDateAfter
- Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateBefore
- Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateAfter
- Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)- Returns:
- GetOrdersResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrdersWithHttpInfo
public ApiResponse<GetOrdersResponse> getOrdersWithHttpInfo(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter) throws ApiException, LWAException
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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.- Parameters:
marketplaceIds
- A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. (required)createdAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)createdBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)orderStatuses
- 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.) (optional)fulfillmentChannels
- 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). (optional)paymentMethods
- 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). (optional)buyerEmail
- The email address of a buyer. Used to select orders that contain the specified email address. (optional)sellerOrderId
- 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. (optional)maxResultsPerPage
- A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. (optional)easyShipShipmentStatuses
- 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.) (optional)electronicInvoiceStatuses
- 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.) (optional)nextToken
- A string token returned in the response of your previous request. (optional)amazonOrderIds
- A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. (optional)actualFulfillmentSupplySourceId
- The `sourceId` of the location from where you want the order fulfilled. (optional)isISPU
- When true, this order is marked to be picked up from a store rather than delivered. (optional)storeChainStoreId
- The store chain store identifier. Linked to a specific store in a store chain. (optional)earliestDeliveryDateBefore
- Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)earliestDeliveryDateAfter
- Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateBefore
- Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateAfter
- Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)- Returns:
- ApiResponse<GetOrdersResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getOrdersAsync
public okhttp3.Call getOrdersAsync(java.util.List<java.lang.String> marketplaceIds, java.lang.String createdAfter, java.lang.String createdBefore, java.lang.String lastUpdatedAfter, java.lang.String lastUpdatedBefore, java.util.List<java.lang.String> orderStatuses, java.util.List<java.lang.String> fulfillmentChannels, java.util.List<java.lang.String> paymentMethods, java.lang.String buyerEmail, java.lang.String sellerOrderId, java.lang.Integer maxResultsPerPage, java.util.List<java.lang.String> easyShipShipmentStatuses, java.util.List<java.lang.String> electronicInvoiceStatuses, java.lang.String nextToken, java.util.List<java.lang.String> amazonOrderIds, java.lang.String actualFulfillmentSupplySourceId, java.lang.Boolean isISPU, java.lang.String storeChainStoreId, java.lang.String earliestDeliveryDateBefore, java.lang.String earliestDeliveryDateAfter, java.lang.String latestDeliveryDateBefore, java.lang.String latestDeliveryDateAfter, ApiCallback<GetOrdersResponse> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.- Parameters:
marketplaceIds
- A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. (required)createdAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)createdBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedAfter
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)lastUpdatedBefore
- 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](https://developer-docs.amazon.com/sp-api/docs/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. (optional)orderStatuses
- 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.) (optional)fulfillmentChannels
- 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). (optional)paymentMethods
- 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). (optional)buyerEmail
- The email address of a buyer. Used to select orders that contain the specified email address. (optional)sellerOrderId
- 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. (optional)maxResultsPerPage
- A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. (optional)easyShipShipmentStatuses
- 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.) (optional)electronicInvoiceStatuses
- 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.) (optional)nextToken
- A string token returned in the response of your previous request. (optional)amazonOrderIds
- A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. (optional)actualFulfillmentSupplySourceId
- The `sourceId` of the location from where you want the order fulfilled. (optional)isISPU
- When true, this order is marked to be picked up from a store rather than delivered. (optional)storeChainStoreId
- The store chain store identifier. Linked to a specific store in a store chain. (optional)earliestDeliveryDateBefore
- Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)earliestDeliveryDateAfter
- Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateBefore
- Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)latestDeliveryDateAfter
- Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. (optional)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
updateVerificationStatus
public void updateVerificationStatus(UpdateVerificationStatusRequest body, java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- The request body for the `updateVerificationStatus` operation. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
updateVerificationStatusWithHttpInfo
public ApiResponse<java.lang.Void> updateVerificationStatusWithHttpInfo(UpdateVerificationStatusRequest body, java.lang.String orderId) throws ApiException, LWAException
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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- The request body for the `updateVerificationStatus` operation. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
updateVerificationStatusAsync
public okhttp3.Call updateVerificationStatusAsync(UpdateVerificationStatusRequest body, java.lang.String orderId, ApiCallback<java.lang.Void> callback) throws ApiException, LWAException
(asynchronously) 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).- Parameters:
body
- The request body for the `updateVerificationStatus` operation. (required)orderId
- An Amazon-defined order identifier, in 3-7-7 format. (required)callback
- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException
- If fail to process the API call, e.g. serializing the request body objectLWAException
- If calls to fetch LWA access token fails
-
-