Module Item Inventory API
Retrieve, Update and Delete Module Item Inventory via the public API endpoint as well as generating inventory variations.
PUT
Module Item Inventory Generate
Generates a single Module Item's Inventory Variations based on the ID passed in the endpoint URL.
/api/v2/admin/module-items/{moduleItemId}/generate-variations
Data / Response:
N/A
Status 204
DELETE
Module Item Inventory Discard
Discards a single Module Item's Inventory Variations based on the ID passed in the endpoint URL.
/api/v2/admin/module-items/{moduleItemId}/discard-variations
Data / Response:
N/A
{
"Enabled": true,
"LowStockNotification": 0,
"HasAttributes": true,
"WhenOutOfStock": "string",
"HasGeneratedInventoryProducts": true,
"InventoryProducts": [
{
"Id": 0,
"SKUCode": "string",
"InStock": 0,
"Enabled": true,
"Title": "string",
"PreOrder": 0
}
]
}
GET
Module Item Inventory Item
Retrieves a single Module Item's Inventory based on the ID passed in the endpoint URL.
/api/v2/admin/module-items/{moduleItemId}/inventory
Data / Response:
N/A
{
"Enabled": true,
"LowStockNotification": 0,
"HasAttributes": true,
"WhenOutOfStock": "string",
"HasGeneratedInventoryProducts": true,
"InventoryProducts": [
{
"Id": 0,
"SKUCode": "string",
"InStock": 0,
"Enabled": true,
"Title": "string",
"PreOrder": 0
}
]
}
PUT
Module Item Inventory Update
Updates a single Module Item's Inventory based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/module-items/{moduleItemId}/inventory
Data / Response:
{
"Enabled": true,
"LowStockNotification": 0,
"WhenOutOfStock": "string",
"InventoryProducts": [
{
"Id": 0,
"SKUCode": "string",
"InStock": 0,
"Enabled": true,
"Title": "string",
"PreOrder": 0
}
]
}
{
"Enabled": true,
"LowStockNotification": 0,
"HasAttributes": true,
"WhenOutOfStock": "string",
"HasGeneratedInventoryProducts": true,
"InventoryProducts": [
{
"Id": 0,
"SKUCode": "string",
"InStock": 0,
"Enabled": true,
"Title": "string",
"PreOrder": 0
}
]
}