InventoryPackageService provides operations for managing inventory packages.
- activateInventoryPackage
- activateInventoryPackages
- addInventoryPackage
- addInventoryPackages
- copyInventoryPackage
- copyInventoryPackages
- deactivateInventoryPackage
- deactivateInventoryPackages
- deleteInventoryPackage
- getInventoryPackage
- getInventoryPackages
- getInventoryPackagesByFilter
- updateInventoryPackage
- updateInventoryPackages
activateInventoryPackage
Activate an inventory package.
Capability required: PackageActivation
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageID | long | The ID of the inventory package to activate. | Req |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
activateInventoryPackages
Activate a list of inventory packages.
Quota is charged for each object in the request.
Capability required: PackageActivation
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageIDs | long[] | The IDs of the inventory packages to activate. | Req |
Response
BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.
addInventoryPackage
Add an inventory package.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackage | InventoryPackage | The inventory package to add. | Req |
Response
InventoryPackageResponse - The response, which indicates if the operation succeeded or failed, and the list of inventory packages.
addInventoryPackages
Add a list of inventory packages.
Quota is charged for each object in the request.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackages | InventoryPackage[] | The list of inventory packages to add. | Req |
Response
InventoryPackageResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of inventory packages.
copyInventoryPackage
Copy an existing inventory package.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageID | long | The ID of the inventory package to copy. | Req |
Response
InventoryPackageResponse - The response, which indicates if the operation succeeded or failed, and the inventory package.
copyInventoryPackages
Copy a list of inventory packages.
Quota is charged for each object in the request.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageIDs | long[] | The IDs of the inventory packages to copy. | Req |
Response
InventoryPackageResponse - The responses, which indicate if the operation succeeded or failed, and the list of inventory packages.
deactivateInventoryPackage
Deactivate an inventory package.
Capability required: PackageActivation
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageID | long | The ID of the inventory package to deactivate. | Req |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deactivateInventoryPackages
Deactivate a list of inventory packages.
Capability required: PackageActivation
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageIDs | long[] | The IDs of the inventory packages to deactivate. | Req |
Response
BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.
deleteInventoryPackage
Delete an inventory package.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageID | long | The ID of the inventory package to delete. | Req |
Response
BasicResponse[] - The response, which indicates if the operation succeeded or failed.
deleteInventoryPackages
Delete a list of inventory packages.
Quota is charged for each object in the request.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageIDs | long[] | The IDs of the inventory packages to delete. | Req |
Response
BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.
getInventoryPackage
Get an inventory package.
Capability required: PackageRead
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageID | long | The ID of the inventory package to retrieve. | Req |
Response
InventoryPackageResponse - The response, which indicates if the operation succeeded or failed, and the inventory package.
getInventoryPackages
Get a list of inventory packages.
Capability required: PackageRead
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackageIDs | long[] | The IDs of the inventory packages to retrieve. | Req |
Response
InventoryPackageResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of inventory packages.
getInventoryPackagesByFilter
Get the inventory packages using a filtering criteria.
Capability required: PackageRead
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| filter | InventoryPackageFilter | The filtering criteria for the inventory package. | Req |
Response
InventoryPackage[] - The list of inventory packages for the given filtering criteria.
updateInventoryPackage
Update an inventory package.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackage | InventoryPackage | The inventory package to update. | Req |
Response
InventoryPackageResponse - The response, which indicates if the operation succeeded or failed, and the inventory package.
updateInventoryPackages
Update a list of inventory packages.
Capability required: PackageWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| inventoryPackages | InventoryPackage[] | The list of inventory packages to update. | Req |
Response
InventoryPackageResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of inventory packages.