IInventoryApi inventoryApi = client.InventoryApi;
InventoryApi
- Deprecated Retrieve Inventory Adjustment
- Retrieve Inventory Adjustment
- Deprecated Batch Change Inventory
- Deprecated Batch Retrieve Inventory Changes
- Deprecated Batch Retrieve Inventory Counts
- Batch Change Inventory
- Batch Retrieve Inventory Changes
- Batch Retrieve Inventory Counts
- Deprecated Retrieve Inventory Physical Count
- Retrieve Inventory Physical Count
- Retrieve Inventory Transfer
- Retrieve Inventory Count
- Retrieve Inventory Changes
This endpoint is deprecated.
Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention.
DeprecatedRetrieveInventoryAdjustmentAsync(
string adjustmentId)
Parameter | Type | Tags | Description |
---|---|---|---|
adjustmentId |
string |
Template, Required | ID of the InventoryAdjustment to retrieve. |
Task<Models.RetrieveInventoryAdjustmentResponse>
string adjustmentId = "adjustment_id0";
try
{
RetrieveInventoryAdjustmentResponse result = await inventoryApi.DeprecatedRetrieveInventoryAdjustmentAsync(adjustmentId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
Returns the InventoryAdjustment object
with the provided adjustment_id
.
RetrieveInventoryAdjustmentAsync(
string adjustmentId)
Parameter | Type | Tags | Description |
---|---|---|---|
adjustmentId |
string |
Template, Required | ID of the InventoryAdjustment to retrieve. |
Task<Models.RetrieveInventoryAdjustmentResponse>
string adjustmentId = "adjustment_id0";
try
{
RetrieveInventoryAdjustmentResponse result = await inventoryApi.RetrieveInventoryAdjustmentAsync(adjustmentId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
This endpoint is deprecated.
Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.
DeprecatedBatchChangeInventoryAsync(
Models.BatchChangeInventoryRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchChangeInventoryRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchChangeInventoryResponse>
Models.BatchChangeInventoryRequest body = new Models.BatchChangeInventoryRequest.Builder(
"8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe"
)
.Changes(
new List<Models.InventoryChange>
{
new Models.InventoryChange.Builder()
.Type("PHYSICAL_COUNT")
.PhysicalCount(
new Models.InventoryPhysicalCount.Builder()
.ReferenceId("1536bfbf-efed-48bf-b17d-a197141b2a92")
.CatalogObjectId("W62UWFY35CWMYGVWK6TWJDNI")
.State("IN_STOCK")
.LocationId("C6W5YS5QM06F5")
.Quantity("53")
.TeamMemberId("LRK57NSQ5X7PUD05")
.OccurredAt("2016-11-16T22:25:24.878Z")
.Build())
.Build(),
})
.IgnoreUnchangedCounts(true)
.Build();
try
{
BatchChangeInventoryResponse result = await inventoryApi.DeprecatedBatchChangeInventoryAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
This endpoint is deprecated.
Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention.
DeprecatedBatchRetrieveInventoryChangesAsync(
Models.BatchRetrieveInventoryChangesRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchRetrieveInventoryChangesRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchRetrieveInventoryChangesResponse>
Models.BatchRetrieveInventoryChangesRequest body = new Models.BatchRetrieveInventoryChangesRequest.Builder()
.CatalogObjectIds(
new List<string>
{
"W62UWFY35CWMYGVWK6TWJDNI",
})
.LocationIds(
new List<string>
{
"C6W5YS5QM06F5",
})
.Types(
new List<string>
{
"PHYSICAL_COUNT",
})
.States(
new List<string>
{
"IN_STOCK",
})
.UpdatedAfter("2016-11-01T00:00:00.000Z")
.UpdatedBefore("2016-12-01T00:00:00.000Z")
.Build();
try
{
BatchRetrieveInventoryChangesResponse result = await inventoryApi.DeprecatedBatchRetrieveInventoryChangesAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
This endpoint is deprecated.
Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention.
DeprecatedBatchRetrieveInventoryCountsAsync(
Models.BatchRetrieveInventoryCountsRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchRetrieveInventoryCountsRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchRetrieveInventoryCountsResponse>
Models.BatchRetrieveInventoryCountsRequest body = new Models.BatchRetrieveInventoryCountsRequest.Builder()
.CatalogObjectIds(
new List<string>
{
"W62UWFY35CWMYGVWK6TWJDNI",
})
.LocationIds(
new List<string>
{
"59TNP9SA8VGDA",
})
.UpdatedAfter("2016-11-16T00:00:00.000Z")
.Build();
try
{
BatchRetrieveInventoryCountsResponse result = await inventoryApi.DeprecatedBatchRetrieveInventoryCountsAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
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.
BatchChangeInventoryAsync(
Models.BatchChangeInventoryRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchChangeInventoryRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchChangeInventoryResponse>
Models.BatchChangeInventoryRequest body = new Models.BatchChangeInventoryRequest.Builder(
"8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe"
)
.Changes(
new List<Models.InventoryChange>
{
new Models.InventoryChange.Builder()
.Type("PHYSICAL_COUNT")
.PhysicalCount(
new Models.InventoryPhysicalCount.Builder()
.ReferenceId("1536bfbf-efed-48bf-b17d-a197141b2a92")
.CatalogObjectId("W62UWFY35CWMYGVWK6TWJDNI")
.State("IN_STOCK")
.LocationId("C6W5YS5QM06F5")
.Quantity("53")
.TeamMemberId("LRK57NSQ5X7PUD05")
.OccurredAt("2016-11-16T22:25:24.878Z")
.Build())
.Build(),
})
.IgnoreUnchangedCounts(true)
.Build();
try
{
BatchChangeInventoryResponse result = await inventoryApi.BatchChangeInventoryAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
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.
BatchRetrieveInventoryChangesAsync(
Models.BatchRetrieveInventoryChangesRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchRetrieveInventoryChangesRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchRetrieveInventoryChangesResponse>
Models.BatchRetrieveInventoryChangesRequest body = new Models.BatchRetrieveInventoryChangesRequest.Builder()
.CatalogObjectIds(
new List<string>
{
"W62UWFY35CWMYGVWK6TWJDNI",
})
.LocationIds(
new List<string>
{
"C6W5YS5QM06F5",
})
.Types(
new List<string>
{
"PHYSICAL_COUNT",
})
.States(
new List<string>
{
"IN_STOCK",
})
.UpdatedAfter("2016-11-01T00:00:00.000Z")
.UpdatedBefore("2016-12-01T00:00:00.000Z")
.Build();
try
{
BatchRetrieveInventoryChangesResponse result = await inventoryApi.BatchRetrieveInventoryChangesAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
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 (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.
BatchRetrieveInventoryCountsAsync(
Models.BatchRetrieveInventoryCountsRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchRetrieveInventoryCountsRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Task<Models.BatchRetrieveInventoryCountsResponse>
Models.BatchRetrieveInventoryCountsRequest body = new Models.BatchRetrieveInventoryCountsRequest.Builder()
.CatalogObjectIds(
new List<string>
{
"W62UWFY35CWMYGVWK6TWJDNI",
})
.LocationIds(
new List<string>
{
"59TNP9SA8VGDA",
})
.UpdatedAfter("2016-11-16T00:00:00.000Z")
.Build();
try
{
BatchRetrieveInventoryCountsResponse result = await inventoryApi.BatchRetrieveInventoryCountsAsync(body);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
This endpoint is deprecated.
Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention.
DeprecatedRetrieveInventoryPhysicalCountAsync(
string physicalCountId)
Parameter | Type | Tags | Description |
---|---|---|---|
physicalCountId |
string |
Template, Required | ID of the InventoryPhysicalCount to retrieve. |
Task<Models.RetrieveInventoryPhysicalCountResponse>
string physicalCountId = "physical_count_id2";
try
{
RetrieveInventoryPhysicalCountResponse result = await inventoryApi.DeprecatedRetrieveInventoryPhysicalCountAsync(physicalCountId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
Returns the InventoryPhysicalCount
object with the provided physical_count_id
.
RetrieveInventoryPhysicalCountAsync(
string physicalCountId)
Parameter | Type | Tags | Description |
---|---|---|---|
physicalCountId |
string |
Template, Required | ID of the InventoryPhysicalCount to retrieve. |
Task<Models.RetrieveInventoryPhysicalCountResponse>
string physicalCountId = "physical_count_id2";
try
{
RetrieveInventoryPhysicalCountResponse result = await inventoryApi.RetrieveInventoryPhysicalCountAsync(physicalCountId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
Returns the InventoryTransfer object
with the provided transfer_id
.
RetrieveInventoryTransferAsync(
string transferId)
Parameter | Type | Tags | Description |
---|---|---|---|
transferId |
string |
Template, Required | ID of the InventoryTransfer to retrieve. |
Task<Models.RetrieveInventoryTransferResponse>
string transferId = "transfer_id6";
try
{
RetrieveInventoryTransferResponse result = await inventoryApi.RetrieveInventoryTransferAsync(transferId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.
RetrieveInventoryCountAsync(
string catalogObjectId,
string locationIds = null,
string cursor = null)
Parameter | Type | Tags | Description |
---|---|---|---|
catalogObjectId |
string |
Template, Required | ID of the CatalogObject to retrieve. |
locationIds |
string |
Query, Optional | The Location IDs to look up as a comma-separated list. An empty list queries all locations. |
cursor |
string |
Query, Optional | 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 guide for more information. |
Task<Models.RetrieveInventoryCountResponse>
string catalogObjectId = "catalog_object_id6";
try
{
RetrieveInventoryCountResponse result = await inventoryApi.RetrieveInventoryCountAsync(catalogObjectId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}
This endpoint is deprecated.
Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations.
You can achieve the same result by calling 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.
RetrieveInventoryChangesAsync(
string catalogObjectId,
string locationIds = null,
string cursor = null)
Parameter | Type | Tags | Description |
---|---|---|---|
catalogObjectId |
string |
Template, Required | ID of the CatalogObject to retrieve. |
locationIds |
string |
Query, Optional | The Location IDs to look up as a comma-separated list. An empty list queries all locations. |
cursor |
string |
Query, Optional | 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 guide for more information. |
Task<Models.RetrieveInventoryChangesResponse>
string catalogObjectId = "catalog_object_id6";
try
{
RetrieveInventoryChangesResponse result = await inventoryApi.RetrieveInventoryChangesAsync(catalogObjectId);
}
catch (ApiException e)
{
// TODO: Handle exception here
Console.WriteLine(e.Message);
}