com.squareup.square.api

Class DefaultInventoryApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultInventoryApi

All Implemented Interfaces:

InventoryApi

public final class DefaultInventoryApi
extends BaseApi
implements InventoryApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultInventoryApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultInventoryApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
BatchChangeInventoryResponse	batchChangeInventory(BatchChangeInventoryRequest body) Applies adjustments and counts to the provided item quantities.
CompletableFuture<BatchChangeInventoryResponse>	batchChangeInventoryAsync(BatchChangeInventoryRequest body) Applies adjustments and counts to the provided item quantities.
BatchRetrieveInventoryChangesResponse	batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body) Returns historical physical counts and adjustments based on the provided filter criteria.
CompletableFuture<BatchRetrieveInventoryChangesResponse>	batchRetrieveInventoryChangesAsync(BatchRetrieveInventoryChangesRequest body) Returns historical physical counts and adjustments based on the provided filter criteria.
BatchRetrieveInventoryCountsResponse	batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body) Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested [Location]($m/Location)s.
CompletableFuture<BatchRetrieveInventoryCountsResponse>	batchRetrieveInventoryCountsAsync(BatchRetrieveInventoryCountsRequest body) Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested [Location]($m/Location)s.
BatchChangeInventoryResponse	deprecatedBatchChangeInventory(BatchChangeInventoryRequest body) Deprecated.
CompletableFuture<BatchChangeInventoryResponse>	deprecatedBatchChangeInventoryAsync(BatchChangeInventoryRequest body) Deprecated.
BatchRetrieveInventoryChangesResponse	deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body) Deprecated.
CompletableFuture<BatchRetrieveInventoryChangesResponse>	deprecatedBatchRetrieveInventoryChangesAsync(BatchRetrieveInventoryChangesRequest body) Deprecated.
BatchRetrieveInventoryCountsResponse	deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body) Deprecated.
CompletableFuture<BatchRetrieveInventoryCountsResponse>	deprecatedBatchRetrieveInventoryCountsAsync(BatchRetrieveInventoryCountsRequest body) Deprecated.
RetrieveInventoryAdjustmentResponse	deprecatedRetrieveInventoryAdjustment(String adjustmentId) Deprecated.
CompletableFuture<RetrieveInventoryAdjustmentResponse>	deprecatedRetrieveInventoryAdjustmentAsync(String adjustmentId) Deprecated.
RetrieveInventoryPhysicalCountResponse	deprecatedRetrieveInventoryPhysicalCount(String physicalCountId) Deprecated.
CompletableFuture<RetrieveInventoryPhysicalCountResponse>	deprecatedRetrieveInventoryPhysicalCountAsync(String physicalCountId) Deprecated.
RetrieveInventoryAdjustmentResponse	retrieveInventoryAdjustment(String adjustmentId) Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided `adjustment_id`.
CompletableFuture<RetrieveInventoryAdjustmentResponse>	retrieveInventoryAdjustmentAsync(String adjustmentId) Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided `adjustment_id`.
RetrieveInventoryChangesResponse	retrieveInventoryChanges(String catalogObjectId, String locationIds, String cursor) Deprecated.
CompletableFuture<RetrieveInventoryChangesResponse>	retrieveInventoryChangesAsync(String catalogObjectId, String locationIds, String cursor) Deprecated.
RetrieveInventoryCountResponse	retrieveInventoryCount(String catalogObjectId, String locationIds, String cursor) Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at a given set of [Location]($m/Location)s.
CompletableFuture<RetrieveInventoryCountResponse>	retrieveInventoryCountAsync(String catalogObjectId, String locationIds, String cursor) Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at a given set of [Location]($m/Location)s.
RetrieveInventoryPhysicalCountResponse	retrieveInventoryPhysicalCount(String physicalCountId) Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided `physical_count_id`.
CompletableFuture<RetrieveInventoryPhysicalCountResponse>	retrieveInventoryPhysicalCountAsync(String physicalCountId) Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided `physical_count_id`.
RetrieveInventoryTransferResponse	retrieveInventoryTransfer(String transferId) Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.
CompletableFuture<RetrieveInventoryTransferResponse>	retrieveInventoryTransferAsync(String transferId) Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInventoryApi

public DefaultInventoryApi(Configuration config,
                           HttpClient httpClient,
                           Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultInventoryApi

public DefaultInventoryApi(Configuration config,
                           HttpClient httpClient,
                           Map<String,AuthManager> authManagers,
                           HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

deprecatedRetrieveInventoryAdjustment

@Deprecated
public RetrieveInventoryAdjustmentResponse deprecatedRetrieveInventoryAdjustment(String adjustmentId)
                                                                                      throws ApiException,
                                                                                             IOException

Deprecated.

Deprecated version of [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedRetrieveInventoryAdjustment in interface InventoryApi

Parameters:

adjustmentId - Required parameter: ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deprecatedRetrieveInventoryAdjustmentAsync

@Deprecated
public CompletableFuture<RetrieveInventoryAdjustmentResponse> deprecatedRetrieveInventoryAdjustmentAsync(String adjustmentId)

Deprecated.

Deprecated version of [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedRetrieveInventoryAdjustmentAsync in interface InventoryApi

Parameters:

adjustmentId - Required parameter: ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

retrieveInventoryAdjustment

public RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String adjustmentId)
                                                                throws ApiException,
                                                                       IOException

Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided `adjustment_id`.

Specified by:

retrieveInventoryAdjustment in interface InventoryApi

Parameters:

adjustmentId - Required parameter: ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveInventoryAdjustmentAsync

public CompletableFuture<RetrieveInventoryAdjustmentResponse> retrieveInventoryAdjustmentAsync(String adjustmentId)

Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided `adjustment_id`.

Specified by:

retrieveInventoryAdjustmentAsync in interface InventoryApi

Parameters:

adjustmentId - Required parameter: ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

deprecatedBatchChangeInventory

@Deprecated
public BatchChangeInventoryResponse deprecatedBatchChangeInventory(BatchChangeInventoryRequest body)
                                                                        throws ApiException,
                                                                               IOException

Deprecated.

Deprecated version of [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchChangeInventory in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchChangeInventoryResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deprecatedBatchChangeInventoryAsync

@Deprecated
public CompletableFuture<BatchChangeInventoryResponse> deprecatedBatchChangeInventoryAsync(BatchChangeInventoryRequest body)

Deprecated.

Deprecated version of [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchChangeInventoryAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchChangeInventoryResponse response from the API call

deprecatedBatchRetrieveInventoryChanges

@Deprecated
public BatchRetrieveInventoryChangesResponse deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
                                                                                          throws ApiException,
                                                                                                 IOException

Deprecated.

Deprecated version of [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchRetrieveInventoryChanges in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryChangesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deprecatedBatchRetrieveInventoryChangesAsync

@Deprecated
public CompletableFuture<BatchRetrieveInventoryChangesResponse> deprecatedBatchRetrieveInventoryChangesAsync(BatchRetrieveInventoryChangesRequest body)

Deprecated.

Deprecated version of [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchRetrieveInventoryChangesAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryChangesResponse response from the API call

deprecatedBatchRetrieveInventoryCounts

@Deprecated
public BatchRetrieveInventoryCountsResponse deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
                                                                                        throws ApiException,
                                                                                               IOException

Deprecated.

Deprecated version of [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchRetrieveInventoryCounts in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryCountsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deprecatedBatchRetrieveInventoryCountsAsync

@Deprecated
public CompletableFuture<BatchRetrieveInventoryCountsResponse> deprecatedBatchRetrieveInventoryCountsAsync(BatchRetrieveInventoryCountsRequest body)

Deprecated.

Deprecated version of [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedBatchRetrieveInventoryCountsAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryCountsResponse response from the API call

batchChangeInventory

public BatchChangeInventoryResponse batchChangeInventory(BatchChangeInventoryRequest body)
                                                  throws ApiException,
                                                         IOException

Applies adjustments and counts to the provided item quantities. On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.

Specified by:

batchChangeInventory in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchChangeInventoryResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchChangeInventoryAsync

public CompletableFuture<BatchChangeInventoryResponse> batchChangeInventoryAsync(BatchChangeInventoryRequest body)

Applies adjustments and counts to the provided item quantities. On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.

Specified by:

batchChangeInventoryAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchChangeInventoryResponse response from the API call

batchRetrieveInventoryChanges

public BatchRetrieveInventoryChangesResponse batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
                                                                    throws ApiException,
                                                                           IOException

Returns historical physical counts and adjustments based on the provided filter criteria. Results are paginated and sorted in ascending order according their `occurred_at` timestamp (oldest first). BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

Specified by:

batchRetrieveInventoryChanges in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryChangesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchRetrieveInventoryChangesAsync

public CompletableFuture<BatchRetrieveInventoryChangesResponse> batchRetrieveInventoryChangesAsync(BatchRetrieveInventoryChangesRequest body)

Returns historical physical counts and adjustments based on the provided filter criteria. Results are paginated and sorted in ascending order according their `occurred_at` timestamp (oldest first). BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

Specified by:

batchRetrieveInventoryChangesAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryChangesResponse response from the API call

batchRetrieveInventoryCounts

public BatchRetrieveInventoryCountsResponse batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
                                                                  throws ApiException,
                                                                         IOException

Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested [Location]($m/Location)s. Results are paginated and sorted in descending order according to their `calculated_at` timestamp (newest first). When `updated_after` is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a "sync" operation, for example in response to receiving a Webhook notification.

Specified by:

batchRetrieveInventoryCounts in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryCountsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchRetrieveInventoryCountsAsync

public CompletableFuture<BatchRetrieveInventoryCountsResponse> batchRetrieveInventoryCountsAsync(BatchRetrieveInventoryCountsRequest body)

Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested [Location]($m/Location)s. Results are paginated and sorted in descending order according to their `calculated_at` timestamp (newest first). When `updated_after` is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a "sync" operation, for example in response to receiving a Webhook notification.

Specified by:

batchRetrieveInventoryCountsAsync in interface InventoryApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveInventoryCountsResponse response from the API call

deprecatedRetrieveInventoryPhysicalCount

@Deprecated
public RetrieveInventoryPhysicalCountResponse deprecatedRetrieveInventoryPhysicalCount(String physicalCountId)
                                                                                            throws ApiException,
                                                                                                   IOException

Deprecated.

Deprecated version of [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCount) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedRetrieveInventoryPhysicalCount in interface InventoryApi

Parameters:

physicalCountId - Required parameter: ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deprecatedRetrieveInventoryPhysicalCountAsync

@Deprecated
public CompletableFuture<RetrieveInventoryPhysicalCountResponse> deprecatedRetrieveInventoryPhysicalCountAsync(String physicalCountId)

Deprecated.

Deprecated version of [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCount) after the endpoint URL is updated to conform to the standard convention.

Specified by:

deprecatedRetrieveInventoryPhysicalCountAsync in interface InventoryApi

Parameters:

physicalCountId - Required parameter: ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

retrieveInventoryPhysicalCount

public RetrieveInventoryPhysicalCountResponse retrieveInventoryPhysicalCount(String physicalCountId)
                                                                      throws ApiException,
                                                                             IOException

Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided `physical_count_id`.

Specified by:

retrieveInventoryPhysicalCount in interface InventoryApi

Parameters:

physicalCountId - Required parameter: ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveInventoryPhysicalCountAsync

public CompletableFuture<RetrieveInventoryPhysicalCountResponse> retrieveInventoryPhysicalCountAsync(String physicalCountId)

Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided `physical_count_id`.

Specified by:

retrieveInventoryPhysicalCountAsync in interface InventoryApi

Parameters:

physicalCountId - Required parameter: ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

retrieveInventoryTransfer

public RetrieveInventoryTransferResponse retrieveInventoryTransfer(String transferId)
                                                            throws ApiException,
                                                                   IOException

Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.

Specified by:

retrieveInventoryTransfer in interface InventoryApi

Parameters:

transferId - Required parameter: ID of the [InventoryTransfer]($m/InventoryTransfer) to retrieve.

Returns:

Returns the RetrieveInventoryTransferResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveInventoryTransferAsync

public CompletableFuture<RetrieveInventoryTransferResponse> retrieveInventoryTransferAsync(String transferId)

Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.

Specified by:

retrieveInventoryTransferAsync in interface InventoryApi

Parameters:

transferId - Required parameter: ID of the [InventoryTransfer]($m/InventoryTransfer) to retrieve.

Returns:

Returns the RetrieveInventoryTransferResponse response from the API call

retrieveInventoryCount

public RetrieveInventoryCountResponse retrieveInventoryCount(String catalogObjectId,
                                                             String locationIds,
                                                             String cursor)
                                                      throws ApiException,
                                                             IOException

Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at a given set of [Location]($m/Location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

Specified by:

retrieveInventoryCount in interface InventoryApi

Parameters:

catalogObjectId - Required parameter: ID of the [CatalogObject]($m/CatalogObject) to retrieve.

locationIds - Optional parameter: The [Location]($m/Location) IDs to look up as a comma-separated list. An empty list queries all locations.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the RetrieveInventoryCountResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveInventoryCountAsync

public CompletableFuture<RetrieveInventoryCountResponse> retrieveInventoryCountAsync(String catalogObjectId,
                                                                                     String locationIds,
                                                                                     String cursor)

Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at a given set of [Location]($m/Location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

Specified by:

retrieveInventoryCountAsync in interface InventoryApi

Parameters:

catalogObjectId - Required parameter: ID of the [CatalogObject]($m/CatalogObject) to retrieve.

locationIds - Optional parameter: The [Location]($m/Location) IDs to look up as a comma-separated list. An empty list queries all locations.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the RetrieveInventoryCountResponse response from the API call

retrieveInventoryChanges

@Deprecated
public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogObjectId,
                                                                             String locationIds,
                                                                             String cursor)
                                                                      throws ApiException,
                                                                             IOException

Deprecated.

Returns a set of physical counts and inventory adjustments for the provided [CatalogObject]($m/CatalogObject) at the requested [Location]($m/Location)s. You can achieve the same result by calling [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint.

Specified by:

retrieveInventoryChanges in interface InventoryApi

Parameters:

catalogObjectId - Required parameter: ID of the [CatalogObject]($m/CatalogObject) to retrieve.

locationIds - Optional parameter: The [Location]($m/Location) IDs to look up as a comma-separated list. An empty list queries all locations.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the RetrieveInventoryChangesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveInventoryChangesAsync

@Deprecated
public CompletableFuture<RetrieveInventoryChangesResponse> retrieveInventoryChangesAsync(String catalogObjectId,
                                                                                                     String locationIds,
                                                                                                     String cursor)

Deprecated.

Returns a set of physical counts and inventory adjustments for the provided [CatalogObject]($m/CatalogObject) at the requested [Location]($m/Location)s. You can achieve the same result by calling [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint.

Specified by:

retrieveInventoryChangesAsync in interface InventoryApi

Parameters:

catalogObjectId - Required parameter: ID of the [CatalogObject]($m/CatalogObject) to retrieve.

locationIds - Optional parameter: The [Location]($m/Location) IDs to look up as a comma-separated list. An empty list queries all locations.

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the RetrieveInventoryChangesResponse response from the API call