Package software.amazon.spapi.api.awd.v2024_05_09

Class AwdApi

  • public class AwdApi
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AwdApi.Builder  

    • Constructor Summary

      Constructors 
      Constructor Description
      AwdApi​(ApiClient apiClient)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      InboundShipment getInboundShipment​(java.lang.String shipmentId, java.lang.String skuQuantities)
      Retrieves an AWD inbound shipment.
      okhttp3.Call getInboundShipmentAsync​(java.lang.String shipmentId, java.lang.String skuQuantities, ApiCallback<InboundShipment> callback)
      (asynchronously) Retrieves an AWD inbound shipment.
      okhttp3.Call getInboundShipmentCall​(java.lang.String shipmentId, java.lang.String skuQuantities, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for getInboundShipment
      ApiResponse<InboundShipment> getInboundShipmentWithHttpInfo​(java.lang.String shipmentId, java.lang.String skuQuantities)
      Retrieves an AWD inbound shipment.
      ShipmentListing listInboundShipments​(java.lang.String sortBy, java.lang.String sortOrder, java.lang.String shipmentStatus, org.threeten.bp.OffsetDateTime updatedAfter, org.threeten.bp.OffsetDateTime updatedBefore, java.lang.Integer maxResults, java.lang.String nextToken)
      Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.
      okhttp3.Call listInboundShipmentsAsync​(java.lang.String sortBy, java.lang.String sortOrder, java.lang.String shipmentStatus, org.threeten.bp.OffsetDateTime updatedAfter, org.threeten.bp.OffsetDateTime updatedBefore, java.lang.Integer maxResults, java.lang.String nextToken, ApiCallback<ShipmentListing> callback)
      (asynchronously) Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.
      okhttp3.Call listInboundShipmentsCall​(java.lang.String sortBy, java.lang.String sortOrder, java.lang.String shipmentStatus, org.threeten.bp.OffsetDateTime updatedAfter, org.threeten.bp.OffsetDateTime updatedBefore, java.lang.Integer maxResults, java.lang.String nextToken, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for listInboundShipments
      ApiResponse<ShipmentListing> listInboundShipmentsWithHttpInfo​(java.lang.String sortBy, java.lang.String sortOrder, java.lang.String shipmentStatus, org.threeten.bp.OffsetDateTime updatedAfter, org.threeten.bp.OffsetDateTime updatedBefore, java.lang.Integer maxResults, java.lang.String nextToken)
      Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.
      InventoryListing listInventory​(java.lang.String sku, java.lang.String sortOrder, java.lang.String details, java.lang.String nextToken, java.lang.Integer maxResults)
      Lists AWD inventory associated with a merchant with the ability to apply optional filters.
      okhttp3.Call listInventoryAsync​(java.lang.String sku, java.lang.String sortOrder, java.lang.String details, java.lang.String nextToken, java.lang.Integer maxResults, ApiCallback<InventoryListing> callback)
      (asynchronously) Lists AWD inventory associated with a merchant with the ability to apply optional filters.
      okhttp3.Call listInventoryCall​(java.lang.String sku, java.lang.String sortOrder, java.lang.String details, java.lang.String nextToken, java.lang.Integer maxResults, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for listInventory
      ApiResponse<InventoryListing> listInventoryWithHttpInfo​(java.lang.String sku, java.lang.String sortOrder, java.lang.String details, java.lang.String nextToken, java.lang.Integer maxResults)
      Lists AWD inventory associated with a merchant with the ability to apply optional filters.
      void setApiClient​(ApiClient apiClient)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AwdApi

        public AwdApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getInboundShipmentCall

        public okhttp3.Call getInboundShipmentCall​(java.lang.String shipmentId,
                                           java.lang.String skuQuantities,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException,
                                           LWAException
        Build call for getInboundShipment
        Parameters:
        shipmentId - ID for the shipment. A shipment contains the cases being inbounded. (required)
        skuQuantities - If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInboundShipment

        public InboundShipment getInboundShipment​(java.lang.String shipmentId,
                                          java.lang.String skuQuantities)
                                   throws ApiException,
                                          LWAException
        Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
        Parameters:
        shipmentId - ID for the shipment. A shipment contains the cases being inbounded. (required)
        skuQuantities - If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities (optional)
        Returns:
        InboundShipment
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInboundShipmentWithHttpInfo

        public ApiResponse<InboundShipment> getInboundShipmentWithHttpInfo​(java.lang.String shipmentId,
                                                                   java.lang.String skuQuantities)
                                                            throws ApiException,
                                                                   LWAException
        Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
        Parameters:
        shipmentId - ID for the shipment. A shipment contains the cases being inbounded. (required)
        skuQuantities - If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities (optional)
        Returns:
        ApiResponse<InboundShipment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInboundShipmentAsync

        public okhttp3.Call getInboundShipmentAsync​(java.lang.String shipmentId,
                                            java.lang.String skuQuantities,
                                            ApiCallback<InboundShipment> callback)
                                     throws ApiException,
                                            LWAException
        (asynchronously) Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
        Parameters:
        shipmentId - ID for the shipment. A shipment contains the cases being inbounded. (required)
        skuQuantities - If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities (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 object
        LWAException - If calls to fetch LWA access token fails

      • listInboundShipmentsCall

        public okhttp3.Call listInboundShipmentsCall​(java.lang.String sortBy,
                                             java.lang.String sortOrder,
                                             java.lang.String shipmentStatus,
                                             org.threeten.bp.OffsetDateTime updatedAfter,
                                             org.threeten.bp.OffsetDateTime updatedBefore,
                                             java.lang.Integer maxResults,
                                             java.lang.String nextToken,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException,
                                             LWAException
        Build call for listInboundShipments
        Parameters:
        sortBy - Field to sort results by. By default, the response will be sorted by UPDATED_AT. (optional)
        sortOrder - Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. (optional)
        shipmentStatus - Filter by inbound shipment status. (optional)
        updatedAfter - List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        updatedBefore - List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • listInboundShipments

        public ShipmentListing listInboundShipments​(java.lang.String sortBy,
                                            java.lang.String sortOrder,
                                            java.lang.String shipmentStatus,
                                            org.threeten.bp.OffsetDateTime updatedAfter,
                                            org.threeten.bp.OffsetDateTime updatedBefore,
                                            java.lang.Integer maxResults,
                                            java.lang.String nextToken)
                                     throws ApiException,
                                            LWAException
        Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sortBy - Field to sort results by. By default, the response will be sorted by UPDATED_AT. (optional)
        sortOrder - Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. (optional)
        shipmentStatus - Filter by inbound shipment status. (optional)
        updatedAfter - List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        updatedBefore - List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        Returns:
        ShipmentListing
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • listInboundShipmentsWithHttpInfo

        public ApiResponse<ShipmentListing> listInboundShipmentsWithHttpInfo​(java.lang.String sortBy,
                                                                     java.lang.String sortOrder,
                                                                     java.lang.String shipmentStatus,
                                                                     org.threeten.bp.OffsetDateTime updatedAfter,
                                                                     org.threeten.bp.OffsetDateTime updatedBefore,
                                                                     java.lang.Integer maxResults,
                                                                     java.lang.String nextToken)
                                                              throws ApiException,
                                                                     LWAException
        Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sortBy - Field to sort results by. By default, the response will be sorted by UPDATED_AT. (optional)
        sortOrder - Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. (optional)
        shipmentStatus - Filter by inbound shipment status. (optional)
        updatedAfter - List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        updatedBefore - List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        Returns:
        ApiResponse<ShipmentListing>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • listInboundShipmentsAsync

        public okhttp3.Call listInboundShipmentsAsync​(java.lang.String sortBy,
                                              java.lang.String sortOrder,
                                              java.lang.String shipmentStatus,
                                              org.threeten.bp.OffsetDateTime updatedAfter,
                                              org.threeten.bp.OffsetDateTime updatedBefore,
                                              java.lang.Integer maxResults,
                                              java.lang.String nextToken,
                                              ApiCallback<ShipmentListing> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sortBy - Field to sort results by. By default, the response will be sorted by UPDATED_AT. (optional)
        sortOrder - Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. (optional)
        shipmentStatus - Filter by inbound shipment status. (optional)
        updatedAfter - List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        updatedBefore - List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (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 object
        LWAException - If calls to fetch LWA access token fails

      • listInventoryCall

        public okhttp3.Call listInventoryCall​(java.lang.String sku,
                                      java.lang.String sortOrder,
                                      java.lang.String details,
                                      java.lang.String nextToken,
                                      java.lang.Integer maxResults,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException,
                                      LWAException
        Build call for listInventory
        Parameters:
        sku - Filter by seller or merchant SKU for the item. (optional)
        sortOrder - Sort the response in `ASCENDING` or `DESCENDING` order. (optional)
        details - Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • listInventory

        public InventoryListing listInventory​(java.lang.String sku,
                                      java.lang.String sortOrder,
                                      java.lang.String details,
                                      java.lang.String nextToken,
                                      java.lang.Integer maxResults)
                               throws ApiException,
                                      LWAException
        Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sku - Filter by seller or merchant SKU for the item. (optional)
        sortOrder - Sort the response in `ASCENDING` or `DESCENDING` order. (optional)
        details - Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        Returns:
        InventoryListing
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • listInventoryWithHttpInfo

        public ApiResponse<InventoryListing> listInventoryWithHttpInfo​(java.lang.String sku,
                                                               java.lang.String sortOrder,
                                                               java.lang.String details,
                                                               java.lang.String nextToken,
                                                               java.lang.Integer maxResults)
                                                        throws ApiException,
                                                               LWAException
        Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sku - Filter by seller or merchant SKU for the item. (optional)
        sortOrder - Sort the response in `ASCENDING` or `DESCENDING` order. (optional)
        details - Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        Returns:
        ApiResponse<InventoryListing>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • listInventoryAsync

        public okhttp3.Call listInventoryAsync​(java.lang.String sku,
                                       java.lang.String sortOrder,
                                       java.lang.String details,
                                       java.lang.String nextToken,
                                       java.lang.Integer maxResults,
                                       ApiCallback<InventoryListing> callback)
                                throws ApiException,
                                       LWAException
        (asynchronously) Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        sku - Filter by seller or merchant SKU for the item. (optional)
        sortOrder - Sort the response in `ASCENDING` or `DESCENDING` order. (optional)
        details - Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        maxResults - Maximum number of results to return. (optional, default to 25)
        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 object
        LWAException - If calls to fetch LWA access token fails