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

Module Item's Related 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}/related-items#

Retrieves a list of module item's related items

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Response

ItemIdinteger

Unique identifier of the parent product in the system.

Namestring · nullable

Name of the module item related item.

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

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

import requests

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

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/1/related-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/related-items");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

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

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

Updates an existing module item's related items

Parameters

moduleItemIdinteger · pathrequired

Module item id.

Body parameters

ItemIdintegerrequired

Unique identifier of the parent product in the system.

Namestringrequired

Name of the update module item related item.

Response

ItemIdinteger

Unique identifier of the parent product in the system.

Namestring · nullable

Name of the module item related item.

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

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

import requests

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

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

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

Response · 200

[
  {
    "ItemId": 1,
    "Name": "Example"
  }
]