Skip to content

Latest commit

 

History

History
674 lines (507 loc) · 21.6 KB

inventory.md

File metadata and controls

674 lines (507 loc) · 21.6 KB
Raw

Inventory

IInventoryApi inventoryApi = client.InventoryApi;

Class Name

InventoryApi

Methods

Deprecated Retrieve Inventory Adjustment

This endpoint is deprecated.

Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention.

DeprecatedRetrieveInventoryAdjustmentAsync(
    string adjustmentId)

Parameters

Parameter Type Tags Description
adjustmentId string Template, Required ID of the InventoryAdjustment to retrieve.

Response Type

Task<Models.RetrieveInventoryAdjustmentResponse>

Example Usage

string adjustmentId = "adjustment_id0";

try
{
    RetrieveInventoryAdjustmentResponse result = await inventoryApi.DeprecatedRetrieveInventoryAdjustmentAsync(adjustmentId);
}
catch (ApiException e){};

Retrieve Inventory Adjustment

Returns the InventoryAdjustment object with the provided adjustment_id.

RetrieveInventoryAdjustmentAsync(
    string adjustmentId)

Parameters

Parameter Type Tags Description
adjustmentId string Template, Required ID of the InventoryAdjustment to retrieve.

Response Type

Task<Models.RetrieveInventoryAdjustmentResponse>

Example Usage

string adjustmentId = "adjustment_id0";

try
{
    RetrieveInventoryAdjustmentResponse result = await inventoryApi.RetrieveInventoryAdjustmentAsync(adjustmentId);
}
catch (ApiException e){};

Deprecated Batch Change Inventory

This endpoint is deprecated.

Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.

DeprecatedBatchChangeInventoryAsync(
    Models.BatchChangeInventoryRequest body)

Parameters

Parameter Type Tags Description
body Models.BatchChangeInventoryRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchChangeInventoryResponse>

Example Usage

var bodyChanges = new List<InventoryChange>();

var bodyChanges0PhysicalCount = new InventoryPhysicalCount.Builder()
    .Id("id0")
    .ReferenceId("1536bfbf-efed-48bf-b17d-a197141b2a92")
    .CatalogObjectId("W62UWFY35CWMYGVWK6TWJDNI")
    .CatalogObjectType("catalog_object_type4")
    .State("IN_STOCK")
    .LocationId("C6W5YS5QM06F5")
    .Quantity("53")
    .TeamMemberId("LRK57NSQ5X7PUD05")
    .OccurredAt("2016-11-16T22:25:24.878Z")
    .Build();
var bodyChanges0Adjustment = new InventoryAdjustment.Builder()
    .Id("id6")
    .ReferenceId("reference_id4")
    .FromState("SOLD")
    .ToState("SOLD_ONLINE")
    .LocationId("location_id0")
    .Build();
var bodyChanges0Transfer = new InventoryTransfer.Builder()
    .Id("id0")
    .ReferenceId("reference_id8")
    .State("UNLINKED_RETURN")
    .FromLocationId("from_location_id2")
    .ToLocationId("to_location_id2")
    .Build();
var bodyChanges0MeasurementUnitMeasurementUnitCustomUnit = new MeasurementUnitCustom.Builder(
        "name0",
        "abbreviation2")
    .Build();
var bodyChanges0MeasurementUnitMeasurementUnit = new MeasurementUnit.Builder()
    .CustomUnit(bodyChanges0MeasurementUnitMeasurementUnitCustomUnit)
    .AreaUnit("IMPERIAL_SQUARE_FOOT")
    .LengthUnit("METRIC_METER")
    .VolumeUnit("METRIC_MILLILITER")
    .WeightUnit("IMPERIAL_WEIGHT_OUNCE")
    .Build();
var bodyChanges0MeasurementUnit = new CatalogMeasurementUnit.Builder()
    .MeasurementUnit(bodyChanges0MeasurementUnitMeasurementUnit)
    .Precision(26)
    .Build();
var bodyChanges0 = new InventoryChange.Builder()
    .Type("PHYSICAL_COUNT")
    .PhysicalCount(bodyChanges0PhysicalCount)
    .Adjustment(bodyChanges0Adjustment)
    .Transfer(bodyChanges0Transfer)
    .MeasurementUnit(bodyChanges0MeasurementUnit)
    .Build();
bodyChanges.Add(bodyChanges0);

var body = new BatchChangeInventoryRequest.Builder(
        "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe")
    .Changes(bodyChanges)
    .IgnoreUnchangedCounts(true)
    .Build();

try
{
    BatchChangeInventoryResponse result = await inventoryApi.DeprecatedBatchChangeInventoryAsync(body);
}
catch (ApiException e){};

Deprecated Batch Retrieve Inventory Changes

This endpoint is deprecated.

Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention.

DeprecatedBatchRetrieveInventoryChangesAsync(
    Models.BatchRetrieveInventoryChangesRequest body)

Parameters

Parameter Type Tags Description
body Models.BatchRetrieveInventoryChangesRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchRetrieveInventoryChangesResponse>

Example Usage

var bodyCatalogObjectIds = new IList<string>();
bodyCatalogObjectIds.Add("W62UWFY35CWMYGVWK6TWJDNI");
var bodyLocationIds = new IList<string>();
bodyLocationIds.Add("C6W5YS5QM06F5");
var bodyTypes = new IList<string>();
bodyTypes.Add("PHYSICAL_COUNT");
var bodyStates = new IList<string>();
bodyStates.Add("IN_STOCK");
var body = new BatchRetrieveInventoryChangesRequest.Builder()
    .CatalogObjectIds(bodyCatalogObjectIds)
    .LocationIds(bodyLocationIds)
    .Types(bodyTypes)
    .States(bodyStates)
    .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){};

Deprecated Batch Retrieve Inventory Counts

This endpoint is deprecated.

Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention.

DeprecatedBatchRetrieveInventoryCountsAsync(
    Models.BatchRetrieveInventoryCountsRequest body)

Parameters

Parameter Type Tags Description
body Models.BatchRetrieveInventoryCountsRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchRetrieveInventoryCountsResponse>

Example Usage

var bodyCatalogObjectIds = new IList<string>();
bodyCatalogObjectIds.Add("W62UWFY35CWMYGVWK6TWJDNI");
var bodyLocationIds = new IList<string>();
bodyLocationIds.Add("59TNP9SA8VGDA");
var bodyStates = new IList<string>();
bodyStates.Add("SUPPORTED_BY_NEWER_VERSION");
var body = new BatchRetrieveInventoryCountsRequest.Builder()
    .CatalogObjectIds(bodyCatalogObjectIds)
    .LocationIds(bodyLocationIds)
    .UpdatedAfter("2016-11-16T00:00:00.000Z")
    .Cursor("cursor0")
    .States(bodyStates)
    .Build();

try
{
    BatchRetrieveInventoryCountsResponse result = await inventoryApi.DeprecatedBatchRetrieveInventoryCountsAsync(body);
}
catch (ApiException e){};

Batch Change Inventory

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)

Parameters

Parameter Type Tags Description
body Models.BatchChangeInventoryRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchChangeInventoryResponse>

Example Usage

var bodyChanges = new List<InventoryChange>();

var bodyChanges0PhysicalCount = new InventoryPhysicalCount.Builder()
    .Id("id0")
    .ReferenceId("1536bfbf-efed-48bf-b17d-a197141b2a92")
    .CatalogObjectId("W62UWFY35CWMYGVWK6TWJDNI")
    .CatalogObjectType("catalog_object_type4")
    .State("IN_STOCK")
    .LocationId("C6W5YS5QM06F5")
    .Quantity("53")
    .TeamMemberId("LRK57NSQ5X7PUD05")
    .OccurredAt("2016-11-16T22:25:24.878Z")
    .Build();
var bodyChanges0Adjustment = new InventoryAdjustment.Builder()
    .Id("id6")
    .ReferenceId("reference_id4")
    .FromState("SOLD")
    .ToState("SOLD_ONLINE")
    .LocationId("location_id0")
    .Build();
var bodyChanges0Transfer = new InventoryTransfer.Builder()
    .Id("id0")
    .ReferenceId("reference_id8")
    .State("UNLINKED_RETURN")
    .FromLocationId("from_location_id2")
    .ToLocationId("to_location_id2")
    .Build();
var bodyChanges0MeasurementUnitMeasurementUnitCustomUnit = new MeasurementUnitCustom.Builder(
        "name0",
        "abbreviation2")
    .Build();
var bodyChanges0MeasurementUnitMeasurementUnit = new MeasurementUnit.Builder()
    .CustomUnit(bodyChanges0MeasurementUnitMeasurementUnitCustomUnit)
    .AreaUnit("IMPERIAL_SQUARE_FOOT")
    .LengthUnit("METRIC_METER")
    .VolumeUnit("METRIC_MILLILITER")
    .WeightUnit("IMPERIAL_WEIGHT_OUNCE")
    .Build();
var bodyChanges0MeasurementUnit = new CatalogMeasurementUnit.Builder()
    .MeasurementUnit(bodyChanges0MeasurementUnitMeasurementUnit)
    .Precision(26)
    .Build();
var bodyChanges0 = new InventoryChange.Builder()
    .Type("PHYSICAL_COUNT")
    .PhysicalCount(bodyChanges0PhysicalCount)
    .Adjustment(bodyChanges0Adjustment)
    .Transfer(bodyChanges0Transfer)
    .MeasurementUnit(bodyChanges0MeasurementUnit)
    .Build();
bodyChanges.Add(bodyChanges0);

var body = new BatchChangeInventoryRequest.Builder(
        "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe")
    .Changes(bodyChanges)
    .IgnoreUnchangedCounts(true)
    .Build();

try
{
    BatchChangeInventoryResponse result = await inventoryApi.BatchChangeInventoryAsync(body);
}
catch (ApiException e){};

Batch Retrieve Inventory Changes

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)

Parameters

Parameter Type Tags Description
body Models.BatchRetrieveInventoryChangesRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchRetrieveInventoryChangesResponse>

Example Usage

var bodyCatalogObjectIds = new IList<string>();
bodyCatalogObjectIds.Add("W62UWFY35CWMYGVWK6TWJDNI");
var bodyLocationIds = new IList<string>();
bodyLocationIds.Add("C6W5YS5QM06F5");
var bodyTypes = new IList<string>();
bodyTypes.Add("PHYSICAL_COUNT");
var bodyStates = new IList<string>();
bodyStates.Add("IN_STOCK");
var body = new BatchRetrieveInventoryChangesRequest.Builder()
    .CatalogObjectIds(bodyCatalogObjectIds)
    .LocationIds(bodyLocationIds)
    .Types(bodyTypes)
    .States(bodyStates)
    .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){};

Batch Retrieve Inventory Counts

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)

Parameters

Parameter Type Tags Description
body Models.BatchRetrieveInventoryCountsRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

Task<Models.BatchRetrieveInventoryCountsResponse>

Example Usage

var bodyCatalogObjectIds = new IList<string>();
bodyCatalogObjectIds.Add("W62UWFY35CWMYGVWK6TWJDNI");
var bodyLocationIds = new IList<string>();
bodyLocationIds.Add("59TNP9SA8VGDA");
var bodyStates = new IList<string>();
bodyStates.Add("SUPPORTED_BY_NEWER_VERSION");
var body = new BatchRetrieveInventoryCountsRequest.Builder()
    .CatalogObjectIds(bodyCatalogObjectIds)
    .LocationIds(bodyLocationIds)
    .UpdatedAfter("2016-11-16T00:00:00.000Z")
    .Cursor("cursor0")
    .States(bodyStates)
    .Build();

try
{
    BatchRetrieveInventoryCountsResponse result = await inventoryApi.BatchRetrieveInventoryCountsAsync(body);
}
catch (ApiException e){};

Deprecated Retrieve Inventory Physical Count

This endpoint is deprecated.

Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention.

DeprecatedRetrieveInventoryPhysicalCountAsync(
    string physicalCountId)

Parameters

Parameter Type Tags Description
physicalCountId string Template, Required ID of the
InventoryPhysicalCount to retrieve.

Response Type

Task<Models.RetrieveInventoryPhysicalCountResponse>

Example Usage

string physicalCountId = "physical_count_id2";

try
{
    RetrieveInventoryPhysicalCountResponse result = await inventoryApi.DeprecatedRetrieveInventoryPhysicalCountAsync(physicalCountId);
}
catch (ApiException e){};

Retrieve Inventory Physical Count

Returns the InventoryPhysicalCount object with the provided physical_count_id.

RetrieveInventoryPhysicalCountAsync(
    string physicalCountId)

Parameters

Parameter Type Tags Description
physicalCountId string Template, Required ID of the
InventoryPhysicalCount to retrieve.

Response Type

Task<Models.RetrieveInventoryPhysicalCountResponse>

Example Usage

string physicalCountId = "physical_count_id2";

try
{
    RetrieveInventoryPhysicalCountResponse result = await inventoryApi.RetrieveInventoryPhysicalCountAsync(physicalCountId);
}
catch (ApiException e){};

Retrieve Inventory Transfer

Returns the InventoryTransfer object with the provided transfer_id.

RetrieveInventoryTransferAsync(
    string transferId)

Parameters

Parameter Type Tags Description
transferId string Template, Required ID of the InventoryTransfer to retrieve.

Response Type

Task<Models.RetrieveInventoryTransferResponse>

Example Usage

string transferId = "transfer_id6";

try
{
    RetrieveInventoryTransferResponse result = await inventoryApi.RetrieveInventoryTransferAsync(transferId);
}
catch (ApiException e){};

Retrieve Inventory Count

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)

Parameters

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.

Response Type

Task<Models.RetrieveInventoryCountResponse>

Example Usage

string catalogObjectId = "catalog_object_id6";
string locationIds = "location_ids0";
string cursor = "cursor6";

try
{
    RetrieveInventoryCountResponse result = await inventoryApi.RetrieveInventoryCountAsync(catalogObjectId, locationIds, cursor);
}
catch (ApiException e){};

Retrieve Inventory Changes

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)

Parameters

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.

Response Type

Task<Models.RetrieveInventoryChangesResponse>

Example Usage

string catalogObjectId = "catalog_object_id6";
string locationIds = "location_ids0";
string cursor = "cursor6";

try
{
    RetrieveInventoryChangesResponse result = await inventoryApi.RetrieveInventoryChangesAsync(catalogObjectId, locationIds, cursor);
}
catch (ApiException e){};