Products service - Get products by producttags

[mvdgraaff]

Name: Products additional get products by productTags
Owner: Eurail
Description:
Currently there are only two ways of getting products via the osdm api specification, 1) get all products, 2) get product by Id.

In most cases the product id is something like an SKU or another type of unique number. That is used in a system to identify a product instance. These Id's can change when a product is replaced by another product. An Id /SKU stays with the lifecycle of a certain product.

The product api elements in OSDM describe tags as:
"product tags associated with the product that can be used to search for offers. This can be omitted outside of the product master data service"

For ordering passes the customers identifies product tags as attributes in the offer request like travel duration, travel days etc. The values should be used to filter the product catalog. By using these tags 0 or more products can be used in the offer or multiple offers are created.

The current OSDM specification doesn't support search by product tags. This limits the possibilities of selling passes therefore Eurail proposes that:
The product api is extended by a Filter by product tags get method.

Input message:

{
    "productSearchCriteria": {
        "id": "",
        "type": "",
        "code": "",
        "owner": "",
        "flexibility": "",
        "travelClass": "",
        "serviceClass": "",
        "fulfillmentOptions": [
            {
                "type": "string",
                "media": "string"
            }
        ],
        "productTags": [
            "string"
        ]
    }
}

Criteria:

• The new POST products-search returns 0..n products.
• Product tags are be default unnamed element therefore dynamic which results in a open filter api.

Alternative

• Get product by Id should return an array of products, in most cases it will only contain one product. When a combination of product tags is used as an id it can return n-products.
• Misusage of get product by id, this causes problems because n-products can be found.

Business value: medium (For Eurail and Pass retailers)
Business outcome: It will become easier to retrieve products for the offer service based product tags therefore more versatile.

[schlpbch]

Next steps:

• Product needs to be extended with some optional attributes
• Add some more ProductsTags Enum for clarification.

[schlpbch]

Next steps

• Add some optional attributes to product
• Add some descriptive enums to ProductTag
• Add a notion to group product tags --> GET product-tags

[ralfbayer-db]

We should also have an endpoint to retrieve the possible product tag values:

GET /productTags returns a list of tags with the group they belong to and a description:

{ 
  "tagList": [ 
    { 
      "tagName": "REDUCTION_25", 
      "tagGroup": "REDUCTION_LEVEL", 
       "tagDescription": "25% Reduction" 
    }, 
    { 
      "tagName": "REDUCTION_50", 
      "tagGroup": "REDUCTION_LEVEL", 
       "tagDescription": "50% Reduction" 
    }    
   ],
  "groupList": [
   {
      "tagGroupName": "REDUCTION_LEVEL",
      "tagGroupDescription": "Percentage of reduction granted"
   }
   ]
}