Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Module Item Grouped Items API

Create, Retrieve, Update and Delete a Module Item's Grouped Items via the public API endpoint.

GET Module Item's Grouped Items List

Retrieves a list of Grouped Items as a JSON response based on your provided query parameters.

/api/v2/admin/module-items/{moduleItemId}/grouped-items

Data / Response:

N/A

{
  "Items": [
    {
      "ItemId": 0,
      "Name": "string",
      "DisplayName": "string",
      "IsMain": true
    }
  ],
  "TotalItemsCount": 0
}

POST Module Item's Grouped Item Create

Creates a new Grouped Item based on the provided data.

/api/v2/admin/module-items/{moduleItemId}/grouped-items

Data / Response:

{
  "ItemId": 0,
  "Name": "string",
  "DisplayName": "string",
  "IsMain": true
}

[
  {
    "ItemId": 0,
    "Name": "string",
    "DisplayName": "string",
    "IsMain": true
  }
]

PUT Module Item's Grouped Item Update

Updates a single Grouped Item based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/module-items/{moduleItemId}/grouped-items

Data / Response:

{
  "ItemId": 0,
  "Name": "string",
  "DisplayName": "string",
  "IsMain": true
}

[
  {
    "ItemId": 0,
    "Name": "string",
    "DisplayName": "string",
    "IsMain": true
  }
]

DELETE Module Item's Grouped Item Delete

Deletes a single Grouped Item based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/{moduleItemId}/grouped-items/{groupProductId}

Data / Response:

N/A

Status 204