Package software.amazon.spapi.api.fba.inventory.v1

Class FbaInventoryApi

  • public class FbaInventoryApi
extends java.lang.Object

    • Constructor Detail

      • FbaInventoryApi

        public FbaInventoryApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • addInventoryCall

        public okhttp3.Call addInventoryCall​(AddInventoryRequest body,
                                     java.lang.String xAmznIdempotencyToken,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException,
                                     LWAException
        Build call for addInventory
        Parameters:
        body - List of items to add to Sandbox inventory. (required)
        xAmznIdempotencyToken - A unique token/requestId provided with each call to ensure idempotency. (required)
        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

      • addInventory

        public AddInventoryResponse addInventory​(AddInventoryRequest body,
                                         java.lang.String xAmznIdempotencyToken)
                                  throws ApiException,
                                         LWAException
        Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - List of items to add to Sandbox inventory. (required)
        xAmznIdempotencyToken - A unique token/requestId provided with each call to ensure idempotency. (required)
        Returns:
        AddInventoryResponse
        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

      • addInventoryWithHttpInfo

        public ApiResponse<AddInventoryResponse> addInventoryWithHttpInfo​(AddInventoryRequest body,
                                                                  java.lang.String xAmznIdempotencyToken)
                                                           throws ApiException,
                                                                  LWAException
        Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - List of items to add to Sandbox inventory. (required)
        xAmznIdempotencyToken - A unique token/requestId provided with each call to ensure idempotency. (required)
        Returns:
        ApiResponse<AddInventoryResponse>
        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

      • addInventoryAsync

        public okhttp3.Call addInventoryAsync​(AddInventoryRequest body,
                                      java.lang.String xAmznIdempotencyToken,
                                      ApiCallback<AddInventoryResponse> callback)
                               throws ApiException,
                                      LWAException
        (asynchronously) Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - List of items to add to Sandbox inventory. (required)
        xAmznIdempotencyToken - A unique token/requestId provided with each call to ensure idempotency. (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 object
        LWAException - If calls to fetch LWA access token fails

      • createInventoryItem

        public CreateInventoryItemResponse createInventoryItem​(CreateInventoryItemRequest body)
                                                throws ApiException,
                                                       LWAException
        Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - CreateInventoryItem Request Body Parameter. (required)
        Returns:
        CreateInventoryItemResponse
        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

      • createInventoryItemWithHttpInfo

        public ApiResponse<CreateInventoryItemResponse> createInventoryItemWithHttpInfo​(CreateInventoryItemRequest body)
                                                                         throws ApiException,
                                                                                LWAException
        Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - CreateInventoryItem Request Body Parameter. (required)
        Returns:
        ApiResponse<CreateInventoryItemResponse>
        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

      • createInventoryItemAsync

        public okhttp3.Call createInventoryItemAsync​(CreateInventoryItemRequest body,
                                             ApiCallback<CreateInventoryItemResponse> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        body - CreateInventoryItem Request Body Parameter. (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 object
        LWAException - If calls to fetch LWA access token fails

      • deleteInventoryItemCall

        public okhttp3.Call deleteInventoryItemCall​(java.lang.String sellerSku,
                                            java.lang.String marketplaceId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException,
                                            LWAException
        Build call for deleteInventoryItem
        Parameters:
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (required)
        marketplaceId - The marketplace ID for the marketplace for which the sellerSku is to be deleted. (required)
        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

      • deleteInventoryItem

        public DeleteInventoryItemResponse deleteInventoryItem​(java.lang.String sellerSku,
                                                       java.lang.String marketplaceId)
                                                throws ApiException,
                                                       LWAException
        Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (required)
        marketplaceId - The marketplace ID for the marketplace for which the sellerSku is to be deleted. (required)
        Returns:
        DeleteInventoryItemResponse
        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

      • deleteInventoryItemWithHttpInfo

        public ApiResponse<DeleteInventoryItemResponse> deleteInventoryItemWithHttpInfo​(java.lang.String sellerSku,
                                                                                java.lang.String marketplaceId)
                                                                         throws ApiException,
                                                                                LWAException
        Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (required)
        marketplaceId - The marketplace ID for the marketplace for which the sellerSku is to be deleted. (required)
        Returns:
        ApiResponse<DeleteInventoryItemResponse>
        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

      • deleteInventoryItemAsync

        public okhttp3.Call deleteInventoryItemAsync​(java.lang.String sellerSku,
                                             java.lang.String marketplaceId,
                                             ApiCallback<DeleteInventoryItemResponse> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
        Parameters:
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (required)
        marketplaceId - The marketplace ID for the marketplace for which the sellerSku is to be deleted. (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 object
        LWAException - If calls to fetch LWA access token fails

      • getInventorySummariesCall

        public okhttp3.Call getInventorySummariesCall​(java.lang.String granularityType,
                                              java.lang.String granularityId,
                                              java.util.List<java.lang.String> marketplaceIds,
                                              java.lang.Boolean details,
                                              org.threeten.bp.OffsetDateTime startDateTime,
                                              java.util.List<java.lang.String> sellerSkus,
                                              java.lang.String sellerSku,
                                              java.lang.String nextToken,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException,
                                              LWAException
        Build call for getInventorySummaries
        Parameters:
        granularityType - The granularity type for the inventory aggregation level. (required)
        granularityId - The granularity ID for the inventory aggregation level. (required)
        marketplaceIds - The marketplace ID for the marketplace for which to return inventory summaries. (required)
        details - true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). (optional, default to false)
        startDateTime - A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. (optional)
        sellerSkus - A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. (optional)
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (optional)
        nextToken - String token returned in the response of your previous request. The string token will expire 30 seconds after being created. (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

      • getInventorySummaries

        public GetInventorySummariesResponse getInventorySummaries​(java.lang.String granularityType,
                                                           java.lang.String granularityId,
                                                           java.util.List<java.lang.String> marketplaceIds,
                                                           java.lang.Boolean details,
                                                           org.threeten.bp.OffsetDateTime startDateTime,
                                                           java.util.List<java.lang.String> sellerSkus,
                                                           java.lang.String sellerSku,
                                                           java.lang.String nextToken)
                                                    throws ApiException,
                                                           LWAException
        Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
        Parameters:
        granularityType - The granularity type for the inventory aggregation level. (required)
        granularityId - The granularity ID for the inventory aggregation level. (required)
        marketplaceIds - The marketplace ID for the marketplace for which to return inventory summaries. (required)
        details - true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). (optional, default to false)
        startDateTime - A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. (optional)
        sellerSkus - A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. (optional)
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (optional)
        nextToken - String token returned in the response of your previous request. The string token will expire 30 seconds after being created. (optional)
        Returns:
        GetInventorySummariesResponse
        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

      • getInventorySummariesWithHttpInfo

        public ApiResponse<GetInventorySummariesResponse> getInventorySummariesWithHttpInfo​(java.lang.String granularityType,
                                                                                    java.lang.String granularityId,
                                                                                    java.util.List<java.lang.String> marketplaceIds,
                                                                                    java.lang.Boolean details,
                                                                                    org.threeten.bp.OffsetDateTime startDateTime,
                                                                                    java.util.List<java.lang.String> sellerSkus,
                                                                                    java.lang.String sellerSku,
                                                                                    java.lang.String nextToken)
                                                                             throws ApiException,
                                                                                    LWAException
        Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
        Parameters:
        granularityType - The granularity type for the inventory aggregation level. (required)
        granularityId - The granularity ID for the inventory aggregation level. (required)
        marketplaceIds - The marketplace ID for the marketplace for which to return inventory summaries. (required)
        details - true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). (optional, default to false)
        startDateTime - A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. (optional)
        sellerSkus - A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. (optional)
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (optional)
        nextToken - String token returned in the response of your previous request. The string token will expire 30 seconds after being created. (optional)
        Returns:
        ApiResponse<GetInventorySummariesResponse>
        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

      • getInventorySummariesAsync

        public okhttp3.Call getInventorySummariesAsync​(java.lang.String granularityType,
                                               java.lang.String granularityId,
                                               java.util.List<java.lang.String> marketplaceIds,
                                               java.lang.Boolean details,
                                               org.threeten.bp.OffsetDateTime startDateTime,
                                               java.util.List<java.lang.String> sellerSkus,
                                               java.lang.String sellerSku,
                                               java.lang.String nextToken,
                                               ApiCallback<GetInventorySummariesResponse> callback)
                                        throws ApiException,
                                               LWAException
        (asynchronously) Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
        Parameters:
        granularityType - The granularity type for the inventory aggregation level. (required)
        granularityId - The granularity ID for the inventory aggregation level. (required)
        marketplaceIds - The marketplace ID for the marketplace for which to return inventory summaries. (required)
        details - true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). (optional, default to false)
        startDateTime - A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. (optional)
        sellerSkus - A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. (optional)
        sellerSku - A single seller SKU used for querying the specified seller SKU inventory summaries. (optional)
        nextToken - String token returned in the response of your previous request. The string token will expire 30 seconds after being created. (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