Edge Service

Overview

The Edge service is a Java, REST-based service deployed on Cloud Foundry. It receives POST events in JSON format through the /events endpoint.

All data that SAP Hybris Profile accepts is context for profiles. This data always enters the system through Context Adapters. For a few use cases, it is necessary to preprocess incoming context before sending it to the context adapters. To do so, the data is first sent to the Edge service, which executes preprocessing before forwarding the data to the appropriate context adapter.

This service accepts a different JSON structure for each of the following request types, indicated by the action_name or type attribute of the JSON:

type=Account Registration: Registration of a new user account
type=Login: Initial sign-in to a session
type=Front End Entered: Initial entry to a site during a session
type=Category View: Viewing a product category
type=Search: Searching for products
type=Product View: Viewing a product's details
type=Add To Cart: Adding one or more products to a cart
type=Change Quantity In Cart: Changing the quantity of a product in a cart
type=Remove From Cart: Removing one or more products from a cart
type='order': Create a new product order
type='order shipment': Define or update order shipment information
type='return': Return an order
type='partial return': Return a subset of an order
type='cancellation': Cancel an order

API Reference

/events

post

Processes given event

Request
Response

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```
hybris-tenant: required (string - minLength: 3 - maxLength: 16 - pattern: ^[a-z][a-z0-9]+$)
The tenant correlated with the current request extracted from the incoming request. Please note that this header's value will always be lowercase, and therefore is case insensitive.
Example:
```
myexampleshop
```
event-type: required (string - minLength: 3 - maxLength: 30 - pattern: ^[a-z-| ]{0,30}$)
The type of event being sent to the edge endpoint.
Example:
```
piwik
```
consent-reference: (string - minLength: 3 - maxLength: 100)
The consent reference associated with this event.
Example:
```
consent-reference
```

Body

Type: application/json

Example:

{
    "action_name": "ProductDetailPageViewEvent",
    "idsite": "cdmtest.default",
    "rec": "1",
    "r": "877998",
    "h": "10",
    "m": "16",
    "s": "11",
    "url": "http://localhost:9000/#!/products/55780c466f4ec8c0230523b0/",
    "_id": "9382c00d623f60e0",
    "_idts": "1437001130",
    "_idvc": "20",
    "_idn": "0",
    "_refts": "0",
    "_viewts": "1439832057",
    "send_image": "0",
    "pdf": "1",
    "qt": "0",
    "realp": "0",
    "wma": "0",
    "dir": "0",
    "fla": "1",
    "java": "1",
    "gears": "0",
    "ag": "0",
    "cookie": "1",
    "res": "2880x1800",
    "cvar": "{\"2\":[\"_pkp\",11.99],\"3\":[\"_pks\",\"55780c466f4ec8c0230523b0\"],\"4\":[\"_pkn\",\"hybris Thermos - Wei’™ \"],\"5\":[\"_pkc\",\"Thermos bottles\"]}",
    "gt_ms": "4",
    "date": 1439828171019
}

HTTP status code 201

Processing started successfully

HTTP status code 400

Request is not valid: is empty or has special characters or payload is malformed

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 408

The request was timed out.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

HTTP status code 429

Too many requests. Please try again.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

HTTP status code 500

Internal server error.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

HTTP status code 503

Service temporarily unavailable. Circuit open.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

/metrics

get

Returns service metrics

Response

HTTP status code 200

The request has succeeded.

Body

Type: application/json

Example:

{
    "metrics": {
        "committedCount": 10,
        "lastDeliveryTimeMs": 69,
        "avgDeliveryTimeMs": 51,
        "deliveredErrors": 0,
        "avgCommitTimeMs": 21,
        "deliveredCount": 10,
        "lastCommitTimeMs": 19,
        "errors": {}
    }
}

/events
/metrics

Headers

Messages posted to the Edge Service using a POST request can have the following headers:

Name	Required?	Description	Example
Accept	No	Standard http header parameter	/
Accept-Language	No	Standard http header parameter	en-US,en;q=0.8
Authorization	Yes	The bearer token issued by yaas.io	Bearer 020-943da2ff-0092-4228-bb4c-b44bfa0f4cb8
consent-reference	No	Consent reference associated with this request (if any)	72a0bd40-da86-4728-9034-625697de14f9
event-type	Yes	The event type that the payload represents	Allowed values: piwik, login, account-registration, profile-commerce-order, profile-commerce-shipment, profile-commerce-return
hybris-tenant	Yes	The requesting tenant. The tenant must be subscribed to SAP Hybris Profile	MyTenant
referer	No	Standard http header parameter	https://some.storefront.com:1234/some/path
user-agent	No	Standard http header parameter	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36

Metamodel

The following interactive graphic displays the routing of incoming messages triggered by a FrontendEntered event.

Use Cases

The Edge service executes preprocessing for various purposes. For example:

Buffering: The Edge service stores incoming events in a message queue so that peaks of incoming context are buffered and don't overwhelm the system.
Transformation: Different systems may send different payloads to represent the same business event. Preprocessing normalizes these differing payloads to streamline subsequent event processing.
Filtering: Invalid events (for example, tenants without a subscription) can be filtered out early to prevent system congestion.
Statistics / insights: Information from multiple independent events can be aggregated to generate meaningful conclusions. For example, within a single browser session, login, page view, add-to-cart, keyword-search, and other events can be aggregated to yield statistics such as average click speed, click speed variance, double-click detection, and session duration.

Account Registration

The account registration event indicates a new user account is registered.

This event header's event-type attribute value is account registration.

This example includes sample values.


{
  "channelRef": "electronics",
  "date": "2016-04-19T17:27:01.479+02:00",
  "type": "account registration",
  "sessionId": "s1961320563312",
  "body": {
    "date": "2016-04-19T17:27:01.479+02:00",
    "identity": {
      "ref": "test@example.com",
      "type": "email"
    },
    "type": "YaaS account",
    "masterData": {
      "address": {
        "firstName": "test",
        "lastName": "test",
        "addition": "hybris",
        "street": "street",
        "number": "1",
        "zip": "80636",
        "city": "Munich",
        "country": "Germany"
      }
    }
  }
}

Login

The Login event indicates an initial login to a session.

This event header's event-type attribute value is login.

This example includes sample values.


{
  "channelRef": "electronics",
  "date": "2016-04-19T17:27:01.479+02:00",
  "type": "login",
  "sessionId": "s1961320563312",
  "body": {
    "date": "2016-04-19T17:27:01.479+02:00",
    "identity": {
      "ref": "test@example.com",
      "type": "email"
    },
    "type": "YaaS account",
    "masterData": {
      "address": {
        "firstName": "test",
        "lastName": "test",
        "addition": "hybris",
        "street": "street",
        "number": "1",
        "zip": "80636",
        "city": "Munich",
        "country": "Germany"
      }
    }
  }
}

Front End Entered

The FrontEndEntered event indicates initial entry to a site during a session.

This event's action_name attribute value is PageViewEvent.
This event header's event-type attribute value is piwik.

This example includes sample values.


{
   "action_name":"PageViewEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822464",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822464",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{}",
   "gt_ms":"0",
   "date":"1465822451422",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":null,
   "search_count":null,
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":null,
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/"
}

Category View

The CategoryPageViewEvent indicates a user viewed a product category.

This event's action_name attribute value is CategoryPageViewEvent.

This event header's event-type attribute value is piwik.

Key attributes are: cvar, where _pkc = product category

The example below includes sample values.


{
   "action_name":"CategoryPageViewEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Film-cameras/c/574",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822208",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822208",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":"{\"categoryName\":\"Film cameras\"}",
   "cvar":"{\"5\":[\"_pkc\",\"Film cameras\"]}",
   "gt_ms":"0",
   "date":"1465822146497",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":"574:Film cameras",
   "search_count":"2",
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":null,
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Film-cameras/c/574"
}

New Order

The New Order event indicates the creation of an order.

This event header's event-type attribute value is profile-commerce-order.

This example includes sample values.


    {
      "type":"order",
      "channelRef":"webshop1",
      "date":"2015-11-25T10:08:21+00:00",
      "consumer":{
        "ref": "someone@mail.com",
        "type": "email"
      },
      "body":{
        "lineItems":[
          {
            "ref":"ABCDEF1",
            "type":"Product",
            "pos":1,
            "quantity":5,
            "unit":"kg",
            "price_list":"17.00",
            "price_effective":"15.00",
            "currency":"EUR",
            "taxAmount":"17%",
            "status":"cancellation requested"
          },
          {
            "ref": "ABCDEF2",
            "type": "Product",
            "pos": 2,
            "quantity": 1,
            "unit": "piece",
            "price_list": "99.00",
            "price_effective": "99.00",
            "currency": "EUR",
            "taxAmount": "17%",
            "status": "pre-order"
          }
        ],
        "promotionInfo":{
          "ref":"xmas2015abc",
          "type":"absolute reduction"
        },
        "paymentInfo":{
          "paymentType":"Master",
          "status":"requested"
        },
        "status":"new",
        "date":"2015-11-25T10:08:21+00:00",
        "orderId":"12a",
        "shipmentInfo":{
          "address":{
            "firstName": "SomeFirstName",
            "lastName": "SomeLastName",
            "addition": "hybris",
            "street": "Some Street",
            "number": "1",
            "zip": "80636",
            "city": "Munich",
            "country": "Germany"
          },
          "carrier":"UPS",
          "trackingRef":"abc123XYZ",
          "status":"not delivered"
        },
        "orderValue":"114.00",
        "currency":"EUR"
      }
    }

Search

The SearchEvent indicates a user searched for products on the site.

This event's action_name attribute value is SearchEvent.
This event header's event-type attribute value is piwik.

This example includes sample values.


{
   "action_name":"SearchEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/search/?text=sd+card",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822464",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822464",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{}",
   "gt_ms":"0",
   "date":"1465822146497",
   "piwik_id":"d5e533f57dada8d1",
   "search":"sd card",
   "search_cat":"sd card",
   "search_count":"24",
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":null,
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/search/?text=sd+card"
}

Product View

The ProductView event indicates a user viewed a product's details.

This event's action_name attribute value is ProductDetailPageViewEvent.
This event header's event-type attribute value is piwik.

Key attributes are:

cvar: where _pkp = product price, _pks = product code, _pkn = product name, _pkc = product category

This example includes sample values.


{
   "action_name":"ProductDetailPageViewEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Digital-Cameras/Digital-SLR/DSLR-A100H/p/816780",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465823104",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465823104",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{\"2\":[\"_pkp\",\"1086.0\"],\"3\":[\"_pks\",\"816780\"],\"4\":[\"_pkn\",\"DSLR-A100H\"],\"5\":[\"_pkc\",\"[\\\"578\\\",\\\"brand_5\\\"]\"]}",
   "gt_ms":"0",
   "date":"1465823086634",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":null,
   "search_count":null,
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":null,
   "userId":"",
   "brand":"Sony",
   "categories":[
      {
         "name":"Digital SLR",
         "code":"578",
         "parentId":"575"
      },
      {
         "name":"Digital Cameras",
         "code":"575",
         "parentId":"571"
      },
      {
         "name":"Brands",
         "code":"brands",
         "parentId":null
      },
      {
         "name":"Sony",
         "code":"brand_5",
         "parentId":"brands"
      },
      {
         "name":"Cameras",
         "code":"571",
         "parentId":"1"
      },
      {
         "name":"Open Catalogue",
         "code":"1",
         "parentId":null
      }
   ],
   "price":"1086.0",
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Digital-Cameras/Digital-SLR/DSLR-A100H/p/816780"
}

Add To Cart

The AddToCartEvent indicates the addition of one or more products to a cart.

This event header's event-type attribute value is piwik.
Key attributes are:

cvar: where ec_id = cart ID
ec_items: [product ID, product name, categories, price, quantity]

SAP Hybris Profile accepts both ECP and Piwik formats for this event. The following examples include sample values.

ECP format:


{
   "action_name":"AddToCartEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Film-cameras/1V/p/898503",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822208",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822208",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{\"1\":[\"ec_id\",\"TEST-00008000-local\"],\"2\":[\"_pkp\",\"1\"],\"3\":[\"_pks\",\"898503\"],\"4\":[\"_pkn\",\"1V\"],\"5\":[\"_pkc\",\"\"]}",
   "gt_ms":"0",
   "date":"1465822211720",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":null,
   "search_count":null,
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":"[[\"898503\",\"1V\",[],\"2117.0\",\"1\"]]",
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/Open-Catalogue/Cameras/Film-cameras/1V/p/898503"
}

Piwik format:


{
   "idgoal":"0",
   "revenue":"16.26",
   "ec_items":"[[\"55dae5e8264ebd7a318c2f59\",\"\",\"\",12.49,0],[\"55dae612264ebd7a318c2f61\",\"\",\"\",19.99,0],[\"55dae59f67ced440e7d5b830\",\"\",\"\",12.49,1]]",
   "idsite":"defaultproj.default",
   "rec":"1",
   "r":"765630",
   "h":"8",
   "m":"13",
   "s":"16",
   "url":"https://profile-shop.us-east.cf.yaas.io/#!/products/55dae59f67ced440e7d5b830/",
   "_id":"959e583c4062827c",
   "_idts":"1455116851",
   "_idvc":"1",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1455116851",
   "send_image":"0",
   "pdf":"1",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"1",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"1",
   "res":"2880x1800",
   "cvar":"{\"1\":[\"cart_id\",\"56b8cba9a34e9411ae2c74e0\"],\"2\":[\"_pkp\",12.49],\"3\":[\"_pks\",\"55dae59f67ced440e7d5b830\"],\"4\":[\"_pkn\",\"hybris Sunglasses - Blue\"],\"5\":[\"_pkc\",\"Sunglasses\"]}",
   "gt_ms":"60",
   "date":1455117196551
}

Shipment

The Shipment event indicates an update to the status of a shipment of an order.

This event header's event-type attribute value is profile-commerce-shipment.

This example includes sample values.


     {
          "type": "order shipment",
          "channelRef": "webshop",
          "date": "2015-11-25T10:08:21+00:00",
          "body": {
               "status": "shipped",
               "date": "2015-11-25T10:08:21+00:00",
               "orderId": "1234",
               "shipmentInfo": {
                    "address": {
                         "firstName": "SomeFirstName",
                         "lastName": "SomeLastName",
                         "addition": "hybris",
                         "street": "Some Street",
                         "number": "1",
                         "zip": "80636",
                         "city": "Munich",
                         "country": "Germany"
                    },
                    "carrier": "DPD",
                    "trackingRef": "abc123XYZ"
               }
          }
     }

Change Quantity In Cart

The ChangeCartQuantity event indicates the user changed the quantity of a product in a cart.

This event header's event-type attribute value is piwik.

Key attributes are:

cvar: where ec_id = cart ID
ec_items: [product ID, product name, categories, price, quantity]

SAP Hybris Profile accepts both ECP and Piwik formats for this event. The following examples include sample values.

ECP format:


{
   "action_name":"AddToCartEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/cart",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822208",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822208",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{\"1\":[\"ec_id\",\"TEST-00008000-local\"],\"2\":[\"_pkp\",\"5\"],\"3\":[\"_pks\",\"898503\"],\"4\":[\"_pkn\",\"\"],\"5\":[\"_pkc\",\"\"]}",
   "gt_ms":"0",
   "date":"1465822257903",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":null,
   "search_count":null,
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":"[[\"898503\",\"\",[],\"undefined\",\"5\"]]",
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/cart"
}

Piwik format:


{
   "idgoal":"0",
   "revenue":"1299.27",
   "ec_items":"[[\"55dae59f67ced440e7d5b830\",\"\",\"\",1236.51,99]]",
   "idsite":"defaultproj.default",
   "rec":"1",
   "r":"497051",
   "h":"10",
   "m":"17",
   "s":"21",
   "url":"https://profile-shop.us-east.cf.yaas.io/#!/products/55dae59f67ced440e7d5b830/",
   "_id":"fa9d4a2e9963e61e",
   "_idts":"1455203347",
   "_idvc":"4",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1455208466",
   "send_image":"0",
   "pdf":"1",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"1",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"1",
   "res":"2880x1800",
   "cvar":"{\"2\":[\"_pkp\",12.49],\"3\":[\"_pks\",\"55dae59f67ced440e7d5b830\"],\"4\":[\"_pkn\",\"hybris Sunglasses - Blue\"],\"5\":[\"_pkc\",\"Sunglasses\"]}",
   "gt_ms":"54",
   "date":1455211041467
}

Return

The Return event indicates the return of an order.

This event header's event-type attribute value is profile-commerce-return.

This example includes sample values.


     {
          "type": "return",
          "channelRef": "webshop",
          "date": "2015-11-25T10:08:21+00:00",
          "body": {
               "status": "complete return",
               "date": "2015-11-25T10:08:21+00:00",
               "orderId": "1234"
          }
     }

Remove From Cart

The RemoveFromCartEvent indicates the user removed one or more products from a cart.

This event header's event-type attribute value is piwik.
Key attributes are:

cvar: where ec_id = cart ID
ec_items: [product ID, product name, categories, price, quantity]

SAP Hybris Profile accepts both ECP and Piwik formats for this event. The following examples include sample values.

ECP format:


{
   "action_name":"RemoveFromCartEvent",
   "idsite":"1",
   "rec":"0",
   "r":"0",
   "h":"0",
   "m":"0",
   "s":"0",
   "url":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/cart",
   "_id":"d5e533f57dada8d1",
   "_idts":"1465822336",
   "_idvc":"0",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1465822336",
   "send_image":"0",
   "pdf":"0",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"0",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"0",
   "res":"1920x1200",
   "data":null,
   "cvar":"{\"1\":[\"ec_id\",\"TEST-00008000-local\"],\"2\":[\"_pkp\",\"0\"],\"3\":[\"_pks\",\"898503\"],\"4\":[\"_pkn\",\"\"],\"5\":[\"_pkc\",\"\"]}",
   "gt_ms":"0",
   "date":"1465822348693",
   "piwik_id":"d5e533f57dada8d1",
   "search":null,
   "search_cat":null,
   "search_count":null,
   "ec_id":null,
   "ec_st":null,
   "ec_tx":null,
   "ec_dt":null,
   "ec_items":"[[\"898503\",\"\",[],\"undefined\",\"0\"]]",
   "userId":"",
   "brand":null,
   "categories":null,
   "price":null,
   "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
   "accept":"*/*",
   "referer":"https://electronics.local:9002/yacceleratorstorefront/electronics/en/cart"
}

Piwik format:


{
   "idgoal":"0",
   "revenue":"0",
   "ec_items":"[[\"55dae59f67ced440e7d5b830\",\"\",\"\",1236.51,0]]",
   "idsite":"defaultproj.default",
   "rec":"1",
   "r":"725386",
   "h":"10",
   "m":"21",
   "s":"26",
   "url":"https://profile-shop.us-east.cf.yaas.io/#!/products/55dae59f67ced440e7d5b830/",
   "_id":"fa9d4a2e9963e61e",
   "_idts":"1455203347",
   "_idvc":"4",
   "_idn":"0",
   "_refts":"0",
   "_viewts":"1455208466",
   "send_image":"0",
   "pdf":"1",
   "qt":"0",
   "realp":"0",
   "wma":"0",
   "dir":"0",
   "fla":"1",
   "java":"0",
   "gears":"0",
   "ag":"0",
   "cookie":"1",
   "res":"2880x1800",
   "cvar":"{\"2\":[\"_pkp\",12.49],\"3\":[\"_pks\",\"55dae59f67ced440e7d5b830\"],\"4\":[\"_pkn\",\"hybris Sunglasses - Blue\"],\"5\":[\"_pkc\",\"Sunglasses\"]}",
   "gt_ms":"54",
   "date":1455211286674
}

Partial Return

The Partial Return event indicates the return of a subset of an order.

This event header's event-type attribute value is profile-commerce-return.

This example includes sample values.


     {
          "type": "partial return",
          "channelRef": "webshop",
          "date": "2015-11-25T10:08:21+00:00",
          "body": {
               "lineItems": [
                    {
                         "ref": "ABC1",
                         "type": "Product",
                         "pos": 1,
                         "quantity": 2,
                         "unit": "kg",
                         "price_list": "6.8",
                         "price_effective": "6",
                         "status": "returned"
                    }
               ],
               "status": "partial return",
               "date": "2015-11-25T10:08:21+00:00",
               "orderId": "1234",
               "returnedOrderValue": "6.8",
               "currency": "EUR"
          }
     }

Cancellation

The Cancellation event indicates the cancellation of an order.

This event header's event-type attribute value is profile-commerce-order.

This example includes sample values.


     {
          "channelRef": "webshop",
          "date": "2015-11-25T10:08:21+00:00",
          "type": "cancellation",
          "body": {
               "status": "cancelled",
               "date": "2015-11-25T10:08:21+00:00",
               "orderId": "1234"
          }
     }

Glossary

Term	Description
authorization	The process of determining whether a given microservice has permission to gain consent.
consent	Permission to access (read, write) specific profile data, for example, permission to read/write age estimation or physical address. A consumer and a tenant can grant and revoke consent for subsets of their respective data.
consent class	A string alias, defined by developers, that references a set of profile data (also called "schemas") for which consent can be granted and revoked. This string is exposed to users (consumers and tenants) as a reference through which they control consent. For example, the consent class "Purchases" might reference a set of data that includes items purchased, purchase dates, and purchase prices. Toggling consent for "Purchase" enables and disables consent for that entire set of data.
consent reference	A unique, randomized string that serves as a passcode to decrypt data associated with one or more schemas. Various service calls require a consent reference.
consumer	The end user whose actions yield profile data in the graph. A profile describes a single consumer.
context	Data that affects the state of the graph. This data can be collected from consumer-triggered events or from third-party sources such as weather stations.
Context Adapter	A microservice that receives data and, optionally, adapts it for entry into the graph. For example, a context adapter can adapt address data by adding a ZIP code and normalizing the street labels (for example, changing "St" to "Street"). The context adapter then passes the data through the Context service, which caches it so that enrichers can subsequently persist the data in the graph.
context repository	A temporary cache for adapted context data, before it is further processed by enrichers and persisted in the graph.
context service	An internal microservice that manages the insertion of, and the retrieval of, context data in the Context Repository.
encryption key	A unique, randomized string used to encrypt and decrypt specific data in the graph. Each data element is encrypted with a different encryption key. Decryption, using this key, is required to access, view, and alter the data.
enricher	A microservice that retrieves data from the Context Repository and/or Graph, possibly alters or extends it, and then persists data in the graph. An enricher can interpret data points, or sets of data points, to yield new data to persist. For example, an enricher can interpret purchasing data and contemporaneous weather station data to yield new data indicating that the consumer is a rainy-day shopper.
graph	The database that stores profile data as nodes, edges, and properties, and allows semantic queries.
identity	One of many independent units of data used to identify a unique profile, such as an email address, browser type, or version.
page bounce	A page visit of very short duration, possibly indicating that the page was not read.
profile	Data about a single consumer, collected and derived from events that are triggered by, or are logically associated, with that consumer.
schema	A string representation of a path in the graph that represents an abstraction, rather than a concrete instance, of a particular data structure.
tenant	A registered entity with a shared commercial goal that subscribes to SAP Hybris Profile services and packages to reach that goal. A tenant can also develop and contribute enrichers and context adapters to the SAP Hybris Profile suite. Within YaaS, a tenant is a project.
variance	An indication of the distribution of a set of values, for example, the distribution of height measurements in a group of people. A high variance indicates a broad distribution of values.

Send feedback
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Get Help
Use our private help channel. Receive updates over email and contact our specialists directly.
hybris Experts
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.

Overview

API Reference

/events

/events

post /events

Headers

Body

HTTP status code 201

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 408

Body

HTTP status code 429

Body

HTTP status code 500

Body

HTTP status code 503

Body

/metrics

/metrics

get /metrics

HTTP status code 200

Body

Headers

Metamodel

Use Cases

Account Registration

Login

Front End Entered

Category View

New Order

Search

Product View

Add To Cart

Shipment

Change Quantity In Cart

Return

Remove From Cart

Partial Return

Cancellation

Glossary