Event schemas

cross_sell_clicked Suggestion clicked

The shopper clicked a suggested product: the tab, the product, its place in the list and the size shown on its card.

When to send it

Shopper app, when a suggestion card is clicked, before the product page opens (S07.12).

Required fields

Field Type Rules Description
client_id integer greater than 0
event "cross_sell_clicked"
tracking_id string a UUID
timestamp_ms integer
product_id string 1–255 characters
tab "recent" | "similar" | "similar_people" | "bought_together"
clicked_product_id string 1–255 characters
position integer at least 1; at most 12
size string | null 1–64 characters; may be null

Optional fields

Field Type Rules Description
event_id string 1–255 characters
schema_version 1
user_agent string at most 2048 characters
shop_country string | null at most 8 characters; may be null
channel string | null at most 64 characters; may be null
instance_id string 1–255 characters
brand_id integer | null greater than 0; may be null
product_associated boolean
ab_data object
testEvent true
extra object

Example

Test values only. This example passes the event's schema.

{
  "event": "cross_sell_clicked",
  "client_id": 1000,
  "tracking_id": "3f0b8c2e-4d5a-4b6c-8d7e-9f0a1b2c3d4e",
  "timestamp_ms": 1792000000000,
  "product_id": "TEST-JACKET-01",
  "tab": "recent",
  "clicked_product_id": "TEST-TIGHTS-02",
  "position": 1,
  "size": "M"
}

Checks and messages

What Tracking debug in your back office checks for this event, with its exact message. An error means the event is not counted; a warning means it is counted but something is likely wrong; an info is a hint.

LevelCheckMessage
error body_data the field: body data is not allowed here, the value was dropped (D110)
error invalid_field what is wrong with the field
error over_limit the field is over the limit of <limit>
error product_id_missing missing product_id
error tracking_id_missing missing tracking_id: the event is rejected. Send the visitor id (fmt_device_id) with every event.
warning product_unknown product not found in your catalogue or has no size chart
warning size_not_in_product size "<value>" is not one of the product's sizes
warning timestamp_missing timestamp_ms is missing or not a time in milliseconds: the time the event was received is used
warning timestamp_out_of_range timestamp_ms is more than 30 days old or more than 3 days ahead: the time the event was received is used
info size_lower_case size "<value>" was sent in lower case. Use uppercase letters or numbers.

JSON schema

The schema the API checks this event against: cross_sell_clicked.schema.json.