Open API v2 / Custom Modules / Module Item's Grouped Items

Module Item's Grouped Items

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

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

Retrieves a list of module item's grouped items

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Response

ItemIdinteger

A unique identifier for a product that is part of a group.

Namestring

Name of the module item grouped item.

DisplayNamestring

Public name that the customer sees on the website.

IsMainboolean

Determines whether this product is the main (base) product in the group.

curl "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "ItemId": 1,
      "Name": "Example",
      "DisplayName": "Example",
      "IsMain": false
    }
  ],
  "TotalItemsCount": 0
}

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

Creates a new module item's grouped item

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Body parameters

ItemIdintegerrequired

A unique identifier for a product that is part of a group.

Namestringrequired

Name of the module item grouped item.

DisplayNamestringrequired

Public name that the customer sees on the website.

IsMainbooleanrequired

Determines whether this product is the main (base) product in the group.

Response

ItemIdinteger

A unique identifier for a product that is part of a group.

Namestring

Name of the module item grouped item.

DisplayNamestring

Public name that the customer sees on the website.

IsMainboolean

Determines whether this product is the main (base) product in the group.

curl -X POST "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ItemId":1,"Name":"Example","DisplayName":"Example","IsMain":false}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "ItemId": 1,
    "Name": "Example",
    "DisplayName": "Example",
    "IsMain": false
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items",
    headers={"Authorization": "Bearer <token>"},
    json={
        "ItemId": 1,
        "Name": "Example",
        "DisplayName": "Example",
        "IsMain": False
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'ItemId' => 1,
        'Name' => 'Example',
        'DisplayName' => 'Example',
        'IsMain' => false
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"ItemId\":1,\"Name\":\"Example\",\"DisplayName\":\"Example\",\"IsMain\":false}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

[
  {
    "ItemId": 1,
    "Name": "Example",
    "DisplayName": "Example",
    "IsMain": false
  }
]

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

Updates an existing module item's grouped item

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Body parameters

ItemIdintegerrequired

A unique identifier for a product that is part of a group.

Namestringrequired

Name of the module item grouped item.

DisplayNamestringrequired

Public name that the customer sees on the website.

IsMainbooleanrequired

Determines whether this product is the main (base) product in the group.

Response

ItemIdinteger

A unique identifier for a product that is part of a group.

Namestring

Name of the module item grouped item.

DisplayNamestring

Public name that the customer sees on the website.

IsMainboolean

Determines whether this product is the main (base) product in the group.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ItemId":1,"Name":"Example","DisplayName":"Example","IsMain":false}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "ItemId": 1,
    "Name": "Example",
    "DisplayName": "Example",
    "IsMain": false
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items",
    headers={"Authorization": "Bearer <token>"},
    json={
        "ItemId": 1,
        "Name": "Example",
        "DisplayName": "Example",
        "IsMain": False
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'ItemId' => 1,
        'Name' => 'Example',
        'DisplayName' => 'Example',
        'IsMain' => false
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"ItemId\":1,\"Name\":\"Example\",\"DisplayName\":\"Example\",\"IsMain\":false}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

[
  {
    "ItemId": 1,
    "Name": "Example",
    "DisplayName": "Example",
    "IsMain": false
  }
]

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

Deletes an existing module item's grouped item

Parameters

moduleItemIdinteger · pathrequired

Module item id.

groupProductIdinteger · pathrequired

Resource identifier.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/module-items/1/grouped-items/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);