Struct square_api_client::api::InventoryApi
source · pub struct InventoryApi { /* private fields */ }Implementations§
source§impl InventoryApi
impl InventoryApi
pub fn new(config: Configuration, client: HttpClient) -> Self
sourcepub async fn retrieve_inventory_count(
&self,
catalog_object_id: &str,
params: RetrieveInventoryCountParams
) -> Result<RetrieveInventoryCountResponse, ApiError>
pub async fn retrieve_inventory_count(
&self,
catalog_object_id: &str,
params: RetrieveInventoryCountParams
) -> Result<RetrieveInventoryCountResponse, ApiError>
Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.
sourcepub async fn retrieve_inventory_transfer(
&self,
transfer_id: &str
) -> Result<RetrieveInventoryTransferResponse, ApiError>
pub async fn retrieve_inventory_transfer(
&self,
transfer_id: &str
) -> Result<RetrieveInventoryTransferResponse, ApiError>
Returns the InventoryTransfer object with the provided transfer_id.
sourcepub async fn retrieve_inventory_adjustment(
&self,
adjustment_id: &str
) -> Result<RetrieveInventoryAdjustmentResponse, ApiError>
pub async fn retrieve_inventory_adjustment(
&self,
adjustment_id: &str
) -> Result<RetrieveInventoryAdjustmentResponse, ApiError>
Returns the InventoryAdjustment object with the provided adjustment id.
sourcepub async fn retrieve_inventory_physical_count(
&self,
physical_count_id: &str
) -> Result<RetrieveInventoryPhysicalCount, ApiError>
pub async fn retrieve_inventory_physical_count(
&self,
physical_count_id: &str
) -> Result<RetrieveInventoryPhysicalCount, ApiError>
Returns the InventoryPhysicalCount object with the provided physical_count_id.
sourcepub async fn batch_change(
&self,
body: &BatchChangeInventoryRequest
) -> Result<BatchChangeInventoryResponse, ApiError>
pub async fn batch_change(
&self,
body: &BatchChangeInventoryRequest
) -> Result<BatchChangeInventoryResponse, ApiError>
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.
sourcepub async fn batch_retrieve_count(
&self,
body: &BatchRetrieveInventoryCountsRequest
) -> Result<BatchRetrieveInventoryCountsResponse, ApiError>
pub async fn batch_retrieve_count(
&self,
body: &BatchRetrieveInventoryCountsRequest
) -> Result<BatchRetrieveInventoryCountsResponse, ApiError>
Returns current counts for the provided CatalogObjects at the requested Locations. Results are paginated and sorted in descending order according to their calculated_at timestamp.
sourcepub async fn batch_retrieve_changes(
&self,
body: &BatchRetrieveInventoryChangesRequest
) -> Result<BatchRetrieveInventoryChangesResponse, ApiError>
pub async fn batch_retrieve_changes(
&self,
body: &BatchRetrieveInventoryChangesRequest
) -> Result<BatchRetrieveInventoryChangesResponse, ApiError>
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.