Difference between revisions of "TagItem"
Jump to navigation
Jump to search
| Line 37: | Line 37: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | bgcolor="#7DC04E" {{!}} '''NEW IN 8.2!''' | + | ParamName=TrackId bgcolor="#7DC04E" {{!}} '''NEW IN 8.2!''' |
| − | |||
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
Revision as of 13:02, 10 August 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
- 'TrackId bgcolor="#7DC04E" | NEW IN 8.2!' (String, optional)
- Recommendation Id
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 |
