Open API v2 / Custom Modules / Module Item Attributes
Module Item Attributes
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Changes existing module item attributes sort order
Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes-order" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '["string"]'
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/attributes-order", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify([ "string" ]) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes-order", headers={"Authorization": "Bearer <token>"}, json=["string"] )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/1/attributes-order', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => ['string'] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes-order"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "[\"string\"]", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Retrieves a list of module item attributes by using a "where" filtering
Parameters
moduleItemIdinteger · pathrequired
Module item id.
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
The identifier of a specific option. Options setting. Read-only.
Optionsarray of objects
The name of the option presented within the Attribute group input.
Idinteger
The identifier of a specific option. Options setting. Read-only.
Namestring
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option.
OptionPricesarray of objects
Price list for different markets.
Valuenumber
The premium amount or fixed cost of the option.
CurrencyCountrystring · nullable
Full name of the country for which this price is relevant.
Currencystring · nullable
Two-letter currency code by standard.
CountryAbbriviationstring · nullable
Two-letter country code.
AttributeTypeenum
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestring
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
curl "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/attributes", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/1/attributes', [ '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/attributes"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"Options": [
{
"Id": 1,
"Name": "Example",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "USD",
"Currency": "USD",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "Checkbox",
"IsInventory": false,
"Name": "Example",
"Required": false,
"ValueType": "FixedPrice"
}
],
"TotalItemsCount": 0
}Creates a new module item attribute
Parameters
moduleItemIdinteger · pathrequired
Module item id.
Body parameters
AttributeTypeenumrequired
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestringrequired
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
Response
Idinteger
The identifier of a specific option. Options setting. Read-only.
Optionsarray of objects
The name of the option presented within the Attribute group input.
Idinteger
The identifier of a specific option. Options setting. Read-only.
Namestring
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option.
OptionPricesarray of objects
Price list for different markets.
Valuenumber
The premium amount or fixed cost of the option.
CurrencyCountrystring · nullable
Full name of the country for which this price is relevant.
Currencystring · nullable
Two-letter currency code by standard.
CountryAbbriviationstring · nullable
Two-letter country code.
AttributeTypeenum
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestring
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
curl -X POST "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"AttributeType":"Checkbox","IsInventory":false,"Name":"Example","Required":false,"ValueType":"FixedPrice"}'
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/1/attributes", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "AttributeType": "Checkbox", "IsInventory": false, "Name": "Example", "Required": false, "ValueType": "FixedPrice" }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes", headers={"Authorization": "Bearer <token>"}, json={ "AttributeType": "Checkbox", "IsInventory": False, "Name": "Example", "Required": False, "ValueType": "FixedPrice" } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/module-items/1/attributes', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'AttributeType' => 'Checkbox', 'IsInventory' => false, 'Name' => 'Example', 'Required' => false, 'ValueType' => 'FixedPrice' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/module-items/1/attributes"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"AttributeType\":\"Checkbox\",\"IsInventory\":false,\"Name\":\"Example\",\"Required\":false,\"ValueType\":\"FixedPrice\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Options": [
{
"Id": 1,
"Name": "Example",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "USD",
"Currency": "USD",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "Checkbox",
"IsInventory": false,
"Name": "Example",
"Required": false,
"ValueType": "FixedPrice"
}Retrieves a single module item attribute
Parameters
idinteger · pathrequired
Module item attribute id.
Response
Idinteger
The identifier of a specific option. Options setting. Read-only.
Optionsarray of objects
The name of the option presented within the Attribute group input.
Idinteger
The identifier of a specific option. Options setting. Read-only.
Namestring
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option.
OptionPricesarray of objects
Price list for different markets.
Valuenumber
The premium amount or fixed cost of the option.
CurrencyCountrystring · nullable
Full name of the country for which this price is relevant.
Currencystring · nullable
Two-letter currency code by standard.
CountryAbbriviationstring · nullable
Two-letter country code.
AttributeTypeenum
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestring
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
curl "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-items/attributes/1', [ '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/attributes/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Options": [
{
"Id": 1,
"Name": "Example",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "USD",
"Currency": "USD",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "Checkbox",
"IsInventory": false,
"Name": "Example",
"Required": false,
"ValueType": "FixedPrice"
}Updates an existing module item attribute
Parameters
idinteger · pathrequired
Existent module item attribute id.
Body parameters
AttributeTypeenumrequired
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestringrequired
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
Response
Idinteger
The identifier of a specific option. Options setting. Read-only.
Optionsarray of objects
The name of the option presented within the Attribute group input.
Idinteger
The identifier of a specific option. Options setting. Read-only.
Namestring
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option.
OptionPricesarray of objects
Price list for different markets.
Valuenumber
The premium amount or fixed cost of the option.
CurrencyCountrystring · nullable
Full name of the country for which this price is relevant.
Currencystring · nullable
Two-letter currency code by standard.
CountryAbbriviationstring · nullable
Two-letter country code.
AttributeTypeenum
Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.Possible values: CheckboxDropdownRadiolistUserInput
IsInventoryboolean
Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated.
Namestring
The title for the attribute group.
Requiredboolean
Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart.
ValueTypeenum
Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice.Possible values: FixedPrice
curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"AttributeType":"Checkbox","IsInventory":false,"Name":"Example","Required":false,"ValueType":"FixedPrice"}'
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "AttributeType": "Checkbox", "IsInventory": false, "Name": "Example", "Required": false, "ValueType": "FixedPrice" }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", headers={"Authorization": "Bearer <token>"}, json={ "AttributeType": "Checkbox", "IsInventory": False, "Name": "Example", "Required": False, "ValueType": "FixedPrice" } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/attributes/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'AttributeType' => 'Checkbox', 'IsInventory' => false, 'Name' => 'Example', 'Required' => false, 'ValueType' => 'FixedPrice' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"AttributeType\":\"Checkbox\",\"IsInventory\":false,\"Name\":\"Example\",\"Required\":false,\"ValueType\":\"FixedPrice\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Options": [
{
"Id": 1,
"Name": "Example",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "USD",
"Currency": "USD",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "Checkbox",
"IsInventory": false,
"Name": "Example",
"Required": false,
"ValueType": "FixedPrice"
}Deletes an existing module item attribute
Parameters
idinteger · pathrequired
Existent module item attribute id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/module-items/attributes/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/attributes/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);