Open API v2 / Custom Modules / Module Item Attribute Options

Module Item Attribute Options

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

POST/api/v2/admin/module-items/attributes/{attributeId}/options#

Creates a new module item attribute option

Parameters
attributeIdinteger · pathrequired
Existent module item attribute id.
Body parameters
Namestringrequired
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option. Use the 'add file' icon () to browse for or upload an image file.
OptionPricesarray of objects
Price list for different markets.
Response
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.
curl -X POST "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1/options" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Image":"string","OptionPrices":[{"Value":0,"CurrencyCountry":"USD","Currency":"USD","CountryAbbriviation":"string"}]}'
Response · 200
{
  "Id": 1,
  "Name": "Example",
  "Image": "string",
  "OptionPrices": [
    {
      "Value": 0,
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "CountryAbbriviation": "string"
    }
  ]
}
PUT/api/v2/admin/module-items/attributes/{id}/attributes-options-order#

Changes existing module item attribute options sort order

Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/attributes/1/attributes-options-order" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '["string"]'
PUT/api/v2/admin/module-items/attributes/options/{id}#

Updates an existing module item attribute option

Parameters
idinteger · pathrequired
Existent module item attribute option id.
Body parameters
Namestringrequired
The title for the attribute group.
Imagestring · nullable
Allows the addition of an image to depict the option. Use the 'add file' icon () to browse for or upload an image file.
OptionPricesarray of objects
Price list for different markets.
Response
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.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/attributes/options/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Image":"string","OptionPrices":[{"Value":0,"CurrencyCountry":"USD","Currency":"USD","CountryAbbriviation":"string"}]}'
Response · 200
{
  "Id": 1,
  "Name": "Example",
  "Image": "string",
  "OptionPrices": [
    {
      "Value": 0,
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "CountryAbbriviation": "string"
    }
  ]
}
DELETE/api/v2/admin/module-items/attributes/options/{id}#

Deletes an existing module item attribute option

Parameters
idinteger · pathrequired
Existent module item attribute option id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/module-items/attributes/options/1" \
  -H "Authorization: Bearer <token>"