Module Item Inventory API

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
    }
  ]
}

Related Articles

• Liquid Components
  module (Custom Modules)
  This module component fetches data relating to Custom Modules.
• OpenAPI (Admin)
  Modules API
  Create, Retrieve, Update and Delete Modules via the public API endpoint using "where" filtering.
• OpenAPI (Admin)
  Module Properties API
  Create, Retrieve, Update and Delete Module Properties via the public API endpoint as well as setting their sort order and Retrieving and Updating Property settings.
• OpenAPI (Admin)
  Module Items API
  Create, Retrieve, Update and Delete Module Items via the public API endpoint using "where" filtering as well as Retrieve and Update Module Item's SEO data.
• Content Modules
  Custom Modules
  Custom Modules can be used to construct simple or complex data structures as a way to dynamically manage the content on your site or web application.
• OpenAPI (Admin)
  Module Items Attributes API
  Create, Retrieve, Update and Delete Module Items Attributes via the public API endpoint via "where" filtering as well as update the attribute sort order.
• OpenAPI (Admin)
  Module Items Attribute Options API
  Create, Update and Delete Module Items Attribute Options via the public API endpoint.
• OpenAPI (Admin)
  Module Item Draft API
  Update and Delete Module Item Drafts via the public API endpoint including the publishing of drafts.
• OpenAPI (Admin)
  Module Item Prices API
  Create, Retrieve, Update and Delete a Module Item's Prices via the public API endpoint.
• OpenAPI (Admin)
  Module Item Related Items API
  Retrieve and Update a Module Item's Related Items via the public API endpoint.
• OpenAPI (Admin)
  Module Item Grouped Items API
  Create, Retrieve, Update and Delete a Module Item's Grouped Items via the public API endpoint.
• OpenAPI (Admin)
  Module Item Parent Items API
  Retrieve and Update a Module Item's Parent Items via the public API endpoint.
• Extensions
  Import/Export of Modules
  Quickly and easily replicate (or back-up) a complete Custom Module configuration via import/export, including; Settings, Properties, Layouts and Table setup.
• OpenAPI (Admin)
  Module Layouts API
  Create, Retrieve, Update or Delete Module Layouts via the public API endpoint using "where" filtering.

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.