InventoryService class
URL: https://developer.squareup.com/reference/square/inventory-api
Programmatically manages a Square seller’s inventory of catalog items.
The Inventory API allows you to programmatically manage inventory counts and inventory changes of products or services.
Constructors
- InventoryService.new({required String baseUrl, required AuthenticationService authenticationService})
Properties
- authenticationService → AuthenticationService
-
final
- baseUrl → String
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchInventoryChange(
{required BatchInventoryChangeRequest request, String? authToken}) → Future< InventoryResponse> - Applies adjustments and counts to the provided item quantities.
-
batchInventoryRead(
{required BatchInventoryReadRequest request, String? authToken}) → Future< InventoryResponse> - Returns historical physical counts and adjustments based on the provided filter criteria.
-
batchInventoryReadCounts(
{required BatchInventoryReadCountRequest request, String? authToken}) → Future< InventoryResponse> - Returns current counts for the provided CatalogObjects at the requested Locations.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readInventoryAdjustment(
{required String adjustmentId, String? authToken}) → Future< InventoryAdjustment> - Returns the InventoryAdjustment object with the provided adjustment_id.
-
readInventoryCount(
{required String catalogObjectId, InventoryCountRequest? request, String? authToken}) → Future< InventoryResponse> - Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.
-
readInventoryPhysicalCount(
{required String physicalCountId, String? authToken}) → Future< InventoryPhysicalCount> -
Returns the InventoryPhysicalCount object with the
provided
physicalCountId. -
readInventoryTransfer(
{required String transferId, String? authToken}) → Future< InventoryTransfer> - Returns the InventoryTransfer object with the provided transfer_id.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited