com.squareup.square.api

Interface InventoryApi

All Known Implementing Classes:

DefaultInventoryApi

public interface InventoryApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

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`.

Method Detail

deprecatedRetrieveInventoryAdjustment

@Deprecated
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.

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
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.

Parameters:

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

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

retrieveInventoryAdjustment

RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String adjustmentId)
                                                         throws ApiException,
                                                                IOException

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

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

CompletableFuture<RetrieveInventoryAdjustmentResponse> retrieveInventoryAdjustmentAsync(String adjustmentId)

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

Parameters:

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

Returns:

Returns the RetrieveInventoryAdjustmentResponse response from the API call

deprecatedBatchChangeInventory

@Deprecated
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.

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
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.

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
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.

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
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.

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
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.

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
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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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
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.

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
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.

Parameters:

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

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

retrieveInventoryPhysicalCount

RetrieveInventoryPhysicalCountResponse retrieveInventoryPhysicalCount(String physicalCountId)
                                                               throws ApiException,
                                                                      IOException

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

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

CompletableFuture<RetrieveInventoryPhysicalCountResponse> retrieveInventoryPhysicalCountAsync(String physicalCountId)

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

Parameters:

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

Returns:

Returns the RetrieveInventoryPhysicalCountResponse response from the API call

retrieveInventoryTransfer

RetrieveInventoryTransferResponse retrieveInventoryTransfer(String transferId)
                                                     throws ApiException,
                                                            IOException

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

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

CompletableFuture<RetrieveInventoryTransferResponse> retrieveInventoryTransferAsync(String transferId)

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

Parameters:

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

Returns:

Returns the RetrieveInventoryTransferResponse response from the API call

retrieveInventoryCount

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.

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

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.

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
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.

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
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.

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