TagEngine
Platform APIs for product tag management, metadata, experiments, and configuration.
Create product tags in bulk from an uploaded CSV/Excel file (delivered via a Grindor storage URL). Processing is asynchronous with job-status polling, a downloadable error file for failed rows, and enriched Kafka publishing identical to the RRA ingest path.
Operations
POST
# Bulk create tags from an uploaded file
GET
# List bulk tag import jobs
GET
# Get a bulk tag import job
FDK Method Name: bulkCreateTags
Create product tags in bulk from a CSV/Excel file. The file must first be uploaded to storage (Grindor); its URL is passed here. Processing is asynchronous — a job id (task_id) is returned and progress is polled via the bulk-create jobs endpoints. Each created tag is also published onto the enriched internal Kafka topic, identical to the RRA ingest path.
Parameters
company_id
string
Required
application_id
string
Required
Request body
url
string
Storage (Grindor) URL of the uploaded CSV/Excel file.
total_records
integer
Number of data rows in the file (excluding the header).
file_name
string
Response
200
Bulk create job accepted
BulkTagCreateResult
status
string
task_id
string
Id of the created bulk import job, polled via the jobs endpoints.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Bulk create tags from an uploaded file
bulkCreateTags
FDK Method Name: listTagImportJobs
List bulk tag import jobs with their status and progress, paginated and filterable by status and action type.
Parameters
company_id
string
Required
application_id
string
Required
status
string
Filter by job status
Enum
action_type
string
Enum
page
integer
Page number (default 1)
Default Value : 1
page_size
integer
Items per page (default 20)
Default Value : 20
Response
200
Paginated bulk tag import jobs
PaginatedTagImportJobs
items
array of object (TagImportJob)
Array of TagImportJob
id
string
status
string
Enum
action_type
string
Enum
file_name
string
url
string
total_records
integer
total_jobs
integer
success_count
integer
error_count
integer
error_url
string
error_message
string
created_by
string
created_on
string
| date-time
updated_on
string
| date-time
page
object (PageInfo)
PageInfo
current
integer
size
integer
total
integer
pages
integer
has_next
boolean
has_previous
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List bulk tag import jobs
listTagImportJobs
FDK Method Name: getTagImportJob
Fetch a single bulk tag import job by id, including status, counts, and the error-file URL.
Parameters
company_id
string
Required
application_id
string
Required
job_id
string
Required
Response
200
Bulk tag import job
TagImportJob
id
string
status
string
Enum
action_type
string
Enum
file_name
string
url
string
total_records
integer
total_jobs
integer
success_count
integer
error_count
integer
error_url
string
error_message
string
created_by
string
created_on
string
| date-time
updated_on
string
| date-time
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get a bulk tag import job
getTagImportJob
Clear the storefront tag cache (V1/V2) on demand by option codes or by a namespace-scoped key pattern, so fresh tags are served before the TTL expires.
Operations
POST
# Clear storefront tag cache
FDK Method Name: clearTagCache
Clear the Redis tag cache (V1 and/or V2) for storefront/public APIs. Provide exactly one of option_codes (clears those codes across all valid service x tenant combinations for V2) or pattern (a glob matched within the tag key namespace only).
Parameters
company_id
string
Required
application_id
string
Required
Request body
option_codes
array of string
pattern
string
version
string
Enum
service
string
tenant
string
Response
200
Cache cleared
CacheClearResult
status
string
message
string
deleted_count
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Clear storefront tag cache
clearTagCache
Manage A/B experiment tags for testing different tag configurations. Supports creating experiments, fetching experimental data, and retrieving category tags by position.
Operations
PUT
# Create or update A/B experiment tags
GET
# Get all experimental tag data
GET
# Get category tags by position
GET
# Get all active tag positions
FDK Method Name: upsertExperiment
Upsert A/B experiment tag configuration for testing different tag setups.
Parameters
company_id
string
Required
application_id
string
Required
Request body
position
string
experiment_name
string
tags
array of object (ExperimentTag)
Array of ExperimentTag
name
string
value
string
Response
200
Experiment upserted
ExperimentData
position
string
experiment_name
string
tags
array of object (ExperimentTag)
Array of ExperimentTag
name
string
value
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Create or update A/B experiment tags
upsertExperiment
FDK Method Name: getExperimentalTagData
Retrieve all A/B experiment tag configurations for the current tenant.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Experimental tag data
Array of ExperimentDataItem
position
string
experiment_name
string
tenant
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all experimental tag data
getExperimentalTagData
FDK Method Name: getCategoryTags
Retrieve category tags filtered by position with visible metadata.
Parameters
company_id
string
Required
application_id
string
Required
position
string
Required
Response
200
Category tags
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get category tags by position
getCategoryTags
FDK Method Name: getAllActiveTags
Retrieve all active tag positions across all services.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Active tags
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all active tag positions
getAllActiveTags
Upload and download tag bucket JSON files for bulk tag management. Supports file upload, download, and cache clearing operations.
Operations
PUT
# Upload tag bucket JSON file
GET
# Download tag bucket file
GET
# Clear tag bucket cache
FDK Method Name: uploadTagBucket
Upload a JSON file containing tag bucket data. Maximum file size is 2MB.
Parameters
company_id
string
Required
application_id
string
Required
Request body
file_name
string
Response
200
File uploaded
StatusMessage
status
string
message
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Upload tag bucket JSON file
uploadTagBucket
FDK Method Name: downloadTagBucket
Download a tag bucket JSON file by file name.
Parameters
company_id
string
Required
application_id
string
Required
file_name
string
Required
Response
200
File content
FileContent
file_name
string
content
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Download tag bucket file
downloadTagBucket
FDK Method Name: clearTagBucketCache
Clear the tag bucket cache to force fresh data on next request.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Cache cleared
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Clear tag bucket cache
clearTagBucketCache
Manage runtime configuration settings for the tag engine service including cache timeouts, batch sizes, and other operational parameters.
Operations
PUT
# Update runtime configuration
GET
# Get all application configurations
GET
# Refresh configuration cache
FDK Method Name: updateConfig
Update a runtime configuration key-value pair for the tag engine service.
Parameters
company_id
string
Required
application_id
string
Required
key
string
Required
value
string
Required
Response
200
Configuration updated
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update runtime configuration
updateConfig
FDK Method Name: getAppConfig
Retrieve all runtime configuration settings for the tag engine service.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Application configurations
AppConfig
key
string
value
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all application configurations
getAppConfig
FDK Method Name: refreshConfigCache
Refresh the runtime configuration cache from the database.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Cache refreshed
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Refresh configuration cache
refreshConfigCache
Fetch product tags by option codes. Tags like Best Price, Selling Fast, and Good Quality are assigned to products and displayed on product listing and detail pages.
Operations
GET
# Get tags by option codes
GET
# Get tags V2 with service and tenant support
FDK Method Name: getTags
Fetch product tags for the given option codes. Returns tags like Best Price, Selling Fast, etc.
Parameters
company_id
string
Required
application_id
string
Required
option_codes
string
Required
fetch_all_tags
string
Enum
nocache
string
Enum
Response
200
Tags fetched successfully
TagListV1
status
string
message
string
tags
array of object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tags by option codes
getTags
FDK Method Name: getTagsV2
Fetch product tags with service type and tenant filtering. Supports A/B experiment values.
Parameters
company_id
string
Required
application_id
string
Required
service
string
Required
Enum
option_codes
string
Required
fetch_all_tags
string
Enum
nocache
string
Enum
experiment_value
string
Response
200
Tags fetched successfully
TagListV2
status
string
tags
array of object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tags V2 with service and tenant support
getTagsV2
Manage tag metadata definitions including priority, visibility, and service-level configuration. Supports CRUD operations on tag metadata and priority hierarchies.
Operations
GET
# Get tag metadata by tag name
GET
# Get tag metadata audit history
POST
# Create or update tag metadata
GET
# Get priority hierarchy for a service
GET
# Filter tag metadata with pagination
GET
# Refresh tag metadata cache
FDK Method Name: getTagMetaData
Retrieve metadata for a specific tag including priority, visibility, and service configuration.
Parameters
company_id
string
Required
application_id
string
Required
tag
string
Required
Response
200
Tag metadata
Array of TagMetaDataItem
id
string
name
string
display_name
string
description
string
category
string
service
string
position
string
visible
boolean
priority
integer
icon_url
string
short_label
string
long_description
string
metadata_image_url
string
countdown_timer
boolean
tenant
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tag metadata by tag name
getTagMetaData
FDK Method Name: getTagHistory
Retrieve the change history for a specific tag. Returns recent updates sorted by most recent first.
Parameters
company_id
string
Required
application_id
string
Required
tag
string
Required
limit
integer
Maximum number of history entries to return (default 10)
Default Value : 10
Response
200
Tag audit history
Array of TagMetaDataHistoryItem
tag_name
string
service
string
position
string
visible
boolean
priority
integer
icon_url
string
display_name
string
description
string
category
string
short_label
string
long_description
string
metadata_image_url
string
countdown_timer
boolean
tenant
string
updated_by
string
created_on
string
| date-time
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tag metadata audit history
getTagHistory
FDK Method Name: upsertTagMetaData
Upsert tag metadata definitions for tags including priority, visibility, and service configuration.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Metadata upserted
Array of TagMetaDataItem
id
string
name
string
display_name
string
description
string
category
string
service
string
position
string
visible
boolean
priority
integer
icon_url
string
short_label
string
long_description
string
metadata_image_url
string
countdown_timer
boolean
tenant
string
Examples
Parameters
body:
body[0]
Was this section helpful?
POST
Response
Create or update tag metadata
upsertTagMetaData
FDK Method Name: getPriorityByService
Retrieve the priority hierarchy of tags for a given service type.
Parameters
company_id
string
Required
application_id
string
Required
service
string
Required
Response
200
Priority hierarchy
TagPriority
priorities
array of object (CategoryTag)
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get priority hierarchy for a service
getPriorityByService
FDK Method Name: filterMetaData
Filter tag metadata by service, tag name, visibility, position, and category. Returns paginated results.
Parameters
company_id
string
Required
application_id
string
Required
service
string
tag_name
string
Substring search on tag name (case-insensitive)
show_tags
string
Enum
position
string
category
string
Filter by bucket category (e.g. Selling Point, Urgency)
page
integer
Page number (default 1)
Default Value : 1
page_size
integer
Items per page (default 20)
Default Value : 20
Response
200
Paginated tag metadata
PaginatedTagMetaData
items
array of object (TagMetaDataItem)
Array of TagMetaDataItem
id
string
name
string
display_name
string
description
string
category
string
service
string
position
string
visible
boolean
priority
integer
icon_url
string
short_label
string
long_description
string
metadata_image_url
string
countdown_timer
boolean
tenant
string
page
object (PageInfo)
PageInfo
current
integer
size
integer
total
integer
pages
integer
has_next
boolean
has_previous
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Filter tag metadata with pagination
filterMetaData
FDK Method Name: refreshTagMetaData
Refresh the in-memory tag metadata cache from the database.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Metadata refreshed
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Refresh tag metadata cache
refreshTagMetaData
Publish product tags to the PLP (Product Listing Page) service via Kafka for real-time tag updates on the storefront.
Operations
POST
# Publish tags to PLP via Kafka
FDK Method Name: publishTags
Publish product tags for the given option codes to the PLP service via Kafka.
Parameters
company_id
string
Required
application_id
string
Required
Request body
option_codes
array of string
Response
200
Tags published
StatusMessage
status
string
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Response