Difference between revisions of "TagItem"
Jump to navigation
Jump to search
| (11 intermediate revisions by 2 users not shown) | |||
| Line 13: | Line 13: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=itemId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=The ID of the item that wants to | + | |ParamDescription=The ID of the item that wants to tag. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=itemType |
|ParamType=[[ItemType]] enum | |ParamType=[[ItemType]] enum | ||
|ParamRequired=required | |ParamRequired=required | ||
| Line 36: | Line 36: | ||
|ParamDescription=The type must be: int when be TagType.Stars or bool for others type | |ParamDescription=The type must be: int when be TagType.Stars or bool for others type | ||
}} | }} | ||
| − | + | '''NEW IN 8.2!''' | |
| − | + | {{Api_Parameter| | |
| + | ParamName=trackId | ||
| + | |ParamType=String | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Recommendation Id | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=uxReference | ||
| + | |ParamType=String | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Recommendation Reference | ||
| + | }} | ||
| Line 49: | Line 60: | ||
: "Severity": 1, | : "Severity": 1, | ||
: "StatusMessage": "OK", | : "StatusMessage": "OK", | ||
| − | : "Content": | + | : "Content": [[ActionExecutedObject]] |
} | } | ||
|Exceptions= | |Exceptions= | ||
* [[AuthenticationRequiredException]] | * [[AuthenticationRequiredException]] | ||
| + | * [[TagsApiNotAvailable]] 295 | ||
* [[InvalidItemException]] 297 NEW | * [[InvalidItemException]] 297 NEW | ||
* [[InvalidBooleanTagValueException]] | * [[InvalidBooleanTagValueException]] | ||
Latest revision as of 14:43, 15 September 2020
Description
Set the Tag for a item of the catalog using a type and the productId passing a value for the tag.
This method only can be used by logged user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- itemId (int, required)
- The ID of the item that wants to tag.
- itemType (ItemType enum, required)
- The type of the item being tagged
- tagType (TagType enum, required)
- Tag type. This is a list of possible values (Enumeration).
- tagValue (String, required)
- The type must be: int when be TagType.Stars or bool for others type
NEW IN 8.2!
- trackId (String, optional)
- Recommendation Id
- uxReference (String, optional)
- Recommendation Reference
Returns
Returns a statuscode 0 if the tag propagated properly
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ActionExecutedObject
}
Exceptions
- AuthenticationRequiredException
- TagsApiNotAvailable 295
- InvalidItemException 297 NEW
- InvalidBooleanTagValueException
- InvalidTagTypeException
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 7.0 | Initial method design | José Manuel Escartín |
