Sitecore API catalog/OrderCloud/Tracking events

Tracking events

Tracking events can be configured for cart, order, and user events that occur in the context of a specific API Client. When these events are triggered by user actions, like adding a line item to a cart, OrderCloud will record specifics about the event and publish a message encapsulating that information so that external systems can be synchronized accordingly. OrderCloud will only publish messages for events that have been configured for the API client in whose context they occur.

Operations

List tracking events

Request

Security
OAuth2(Required scopes: FullAccessTrackingEventAdminTrackingEventReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""EventType"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ID""EventType""!ID""!EventType"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/integrations/trackingEvents?search=string&searchOn=ID&sortBy=ID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(TrackingEvent)
Example:
[
  {
    "ID": "",
    "EventType": "UserLoggedIn",
    "ClientID": "",
    "Name": "",
    "ConfigData": {},
    "DeliveryConfigID": ""
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}