Module Items Attributes API
Create, Retrieve, Update and Delete Module Items Attributes via the public API endpoint via "where" filtering as well as update the attribute sort order.
GET
Module Item Attributes List
Retrieves a list of Attributes as a JSON response based on your provided query parameters.
/api/v2/admin/module-items/{moduleItemId}/attributes
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"Options": [
{
"Id": 0,
"Name": "string",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "string",
"Currency": "string",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
],
"TotalItemsCount": 0
}
POST
Module Item Attribute Create
Creates a new Attribute based on the provided data.
/api/v2/admin/module-items/{moduleItemId}/attributes
Data / Response:
{
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
{
"Id": 0,
"Options": [
{
"Id": 0,
"Name": "string",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "string",
"Currency": "string",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
GET
Module Item Attribute Item
Retrieves a single Attribute based on the ID passed in the endpoint URL.
/api/v2/admin/module-items/attributes/{id}
Data / Response:
N/A
{
"Id": 0,
"Options": [
{
"Id": 0,
"Name": "string",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "string",
"Currency": "string",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
PUT
Module Item Attribute Update
Updates a single Attribute based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/module-items/attributes/{id}
Data / Response:
{
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
{
"Id": 0,
"Options": [
{
"Id": 0,
"Name": "string",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "string",
"Currency": "string",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
DELETE
Module Item Attribute Delete
Deletes a single Attribute based on the ID passed in the endpoint URL.
/api/v2/admin/module-items/attributes/{id}
Data / Response:
N/A
Status 204
POST
Module Item Attribute Set Sort Order
Sets the sort order of Attributes based on the data provided.
/api/v2/admin/module-items/{moduleItemId}/attributes-order
Data / Response:
[
0
]
[
{
"Id": 0,
"Options": [
{
"Id": 0,
"Name": "string",
"Image": "string",
"OptionPrices": [
{
"Value": 0,
"CurrencyCountry": "string",
"Currency": "string",
"CountryAbbriviation": "string"
}
]
}
],
"AttributeType": "string",
"IsInventory": true,
"Name": "string",
"Required": true,
"ValueType": "string"
}
]