Manages filter mappings that translate a retailer's own product filter vocabulary into the filters Epsilon Retail Media applies when selecting ads. Five operations — create, list, get, update and delete a filter mapping — authenticated with a JWT bearer token in the Authorization header.
{
"openapi": "3.0.0",
"info": {
"title": "Citrus filter-mapping API",
"version": "0.0.1-alpha",
"x-source": "https://developers.citrusad.com/integration/reference/"
},
"servers": [
{
"url": "https://$BASE_URL.citrusad.com/v1"
}
],
"components": {
"responses": {
"InvalidRequest": {
"description": "There was a problem with input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"UnAuthorized": {
"description": "Login failed or token not valid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ErrorResponse": {
"description": "There was a server problem.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"NotFound": {
"description": "Resource Not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
}
},
"securitySchemes": {
"TokenSecurity": {
"in": "header",
"name": "Authorization",
"description": "For accessing the API a valid JWT jwt must be passed in all queries in\nthe 'Authorization' header. The following syntax must be used in the\n'Authorization' header.\n\nBearer xxx.yyy.zzz\n",
"type": "apiKey"
}
},
"schemas": {
"Response": {
"type": "object",
"properties": {
"errorMessages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
}
}
},
"isSuccessful": {
"type": "boolean"
}
}
},
"CreateFilterMappingRequest": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"catalogId": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"required": [
"catalogId",
"filter",
"displayName"
]
},
"FilterMapping": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"catalogId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"catalogId",
"filter",
"displayName"
]
},
"ListFilterMappingsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"type": "string"
},
"filterMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterMapping"
}
}
}
},
"UpdateFilterMappingRequest": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"catalogId": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"required": [
"catalogId",
"filter",
"displayName"
]
}
}
},
"security": [
{
"TokenSecurity": []
}
],
"paths": {
"/filter-mapping": {
"post": {
"summary": "create filter mapping",
"responses": {
"200": {
"description": "created FilterMapping object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterMapping"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/UnAuthorized"
},
"403": {
"$ref": "#/components/responses/UnAuthorized"
},
"500": {
"$ref": "#/components/responses/ErrorResponse"
}
},
"operationId": "createFilterMapping",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFilterMappingRequest"
}
}
},
"required": true
},
"tags": [
"filterMapping"
]
},
"get": {
"summary": "get list of filter mappings",
"responses": {
"200": {
"description": "A list of filterMapping objects for catalog",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFilterMappingsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/UnAuthorized"
},
"403": {
"$ref": "#/components/responses/UnAuthorized"
},
"500": {
"$ref": "#/components/responses/ErrorResponse"
}
},
"operationId": "listFilterMappings",
"parameters": [
{
"name": "catalogId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "pageToken",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"filterMapping"
]
}
},
"/filter-mapping/{id}": {
"patch": {
"summary": "update a filter mapping",
"responses": {
"200": {
"description": "updated FilterMapping object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterMapping"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/UnAuthorized"
},
"403": {
"$ref": "#/components/responses/UnAuthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/ErrorResponse"
}
},
"operationId": "updateFilterMapping",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFilterMappingRequest"
}
}
},
"required": true
},
"tags": [
"filterMapping"
]
},
"get": {
"summary": "get a filter mapping",
"responses": {
"200": {
"description": "A filterMapping object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterMapping"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/UnAuthorized"
},
"403": {
"$ref": "#/components/responses/UnAuthorized"
},
"500": {
"$ref": "#/components/responses/ErrorResponse"
}
},
"operationId": "getFilterMapping",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"filterMapping"
]
},
"delete": {
"summary": "delete a filter mapping",
"responses": {
"200": {
"description": "standard success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/UnAuthorized"
},
"403": {
"$ref": "#/components/responses/UnAuthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/ErrorResponse"
}
},
"operationId": "deleteFilterMapping",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"filterMapping"
]
}
}
}
}