130 lines
3.7 KiB
Markdown
130 lines
3.7 KiB
Markdown
---
|
|
name: inventory-routes
|
|
description: Handle 13 OpenAPI operation(s) under /v2/inventory for the inventory route group.
|
|
---
|
|
|
|
# inventory API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /v2/inventory for the inventory route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### deprecated_retrieve_inventory_adjustment
|
|
|
|
- Operation ID: `deprecated_retrieve_inventory_adjustment`
|
|
- Route: `GET /v2/inventory/adjustment/{adjustment_id}`
|
|
- Mode: READ
|
|
- Summary: DeprecatedRetrieveInventoryAdjustment
|
|
- Parameters:
|
|
- `adjustment_id` in `path` required
|
|
|
|
### retrieve_inventory_adjustment
|
|
|
|
- Operation ID: `retrieve_inventory_adjustment`
|
|
- Route: `GET /v2/inventory/adjustments/{adjustment_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveInventoryAdjustment
|
|
- Parameters:
|
|
- `adjustment_id` in `path` required
|
|
|
|
### deprecated_batch_change_inventory
|
|
|
|
- Operation ID: `deprecated_batch_change_inventory`
|
|
- Route: `POST /v2/inventory/batch-change`
|
|
- Mode: WRITE
|
|
- Summary: DeprecatedBatchChangeInventory
|
|
- Body: JSON request body accepted.
|
|
|
|
### deprecated_batch_retrieve_inventory_changes
|
|
|
|
- Operation ID: `deprecated_batch_retrieve_inventory_changes`
|
|
- Route: `POST /v2/inventory/batch-retrieve-changes`
|
|
- Mode: WRITE
|
|
- Summary: DeprecatedBatchRetrieveInventoryChanges
|
|
- Body: JSON request body accepted.
|
|
|
|
### deprecated_batch_retrieve_inventory_counts
|
|
|
|
- Operation ID: `deprecated_batch_retrieve_inventory_counts`
|
|
- Route: `POST /v2/inventory/batch-retrieve-counts`
|
|
- Mode: WRITE
|
|
- Summary: DeprecatedBatchRetrieveInventoryCounts
|
|
- Body: JSON request body accepted.
|
|
|
|
### batch_change_inventory
|
|
|
|
- Operation ID: `batch_change_inventory`
|
|
- Route: `POST /v2/inventory/changes/batch-create`
|
|
- Mode: WRITE
|
|
- Summary: BatchChangeInventory
|
|
- Body: JSON request body accepted.
|
|
|
|
### batch_retrieve_inventory_changes
|
|
|
|
- Operation ID: `batch_retrieve_inventory_changes`
|
|
- Route: `POST /v2/inventory/changes/batch-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BatchRetrieveInventoryChanges
|
|
- Body: JSON request body accepted.
|
|
|
|
### batch_retrieve_inventory_counts
|
|
|
|
- Operation ID: `batch_retrieve_inventory_counts`
|
|
- Route: `POST /v2/inventory/counts/batch-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BatchRetrieveInventoryCounts
|
|
- Body: JSON request body accepted.
|
|
|
|
### deprecated_retrieve_inventory_physical_count
|
|
|
|
- Operation ID: `deprecated_retrieve_inventory_physical_count`
|
|
- Route: `GET /v2/inventory/physical-count/{physical_count_id}`
|
|
- Mode: READ
|
|
- Summary: DeprecatedRetrieveInventoryPhysicalCount
|
|
- Parameters:
|
|
- `physical_count_id` in `path` required
|
|
|
|
### retrieve_inventory_physical_count
|
|
|
|
- Operation ID: `retrieve_inventory_physical_count`
|
|
- Route: `GET /v2/inventory/physical-counts/{physical_count_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveInventoryPhysicalCount
|
|
- Parameters:
|
|
- `physical_count_id` in `path` required
|
|
|
|
### retrieve_inventory_transfer
|
|
|
|
- Operation ID: `retrieve_inventory_transfer`
|
|
- Route: `GET /v2/inventory/transfers/{transfer_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveInventoryTransfer
|
|
- Parameters:
|
|
- `transfer_id` in `path` required
|
|
|
|
### retrieve_inventory_count
|
|
|
|
- Operation ID: `retrieve_inventory_count`
|
|
- Route: `GET /v2/inventory/{catalog_object_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveInventoryCount
|
|
- Parameters:
|
|
- `catalog_object_id` in `path` required
|
|
- `location_ids` in `query`
|
|
- `cursor` in `query`
|
|
|
|
### retrieve_inventory_changes
|
|
|
|
- Operation ID: `retrieve_inventory_changes`
|
|
- Route: `GET /v2/inventory/{catalog_object_id}/changes`
|
|
- Mode: READ
|
|
- Summary: RetrieveInventoryChanges
|
|
- Parameters:
|
|
- `catalog_object_id` in `path` required
|
|
- `location_ids` in `query`
|
|
- `cursor` in `query`
|