Skip to main content
POST
/
stores
/
{storeId}
/
storefront
/
events
Receive Storefront Events
curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/storefront/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventId": "<string>",
  "eventName": "product_added_to_cart",
  "source": "AIMERCE",
  "timestamp": "2023-11-07T05:31:56Z",
  "anonymousId": "<string>",
  "cart": {},
  "cartLine": {},
  "checkout": {},
  "collection": {},
  "customer": {},
  "customerEmail": "[email protected]",
  "customerPhone": "<string>",
  "productVariant": {},
  "urlWithParams": "<string>",
  "urlWithoutParams": "<string>"
}
'
{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json

Shopify pixel event for storefront tracking.

​
eventId
string
required

Unique identifier for the event.

​
eventName
enum<string>
required

Name of the Shopify pixel event.

Available options:
product_added_to_cart,
product_removed_from_cart,
product_viewed,
checkout_started,
checkout_completed,
checkout_contact_info_submitted,
page_viewed,
collection_viewed
​
source
enum<string>
required

Source of the event.

Available options:
AIMERCE
​
timestamp
string<date-time>
required

ISO 8601 timestamp when the event occurred.

​
anonymousId
string

Anonymous identifier for users without account.

​
cart
object

Cart information.

​
cartLine
object

Information about specific cart line item.

​
checkout
object

Checkout information.

​
collection
object

Collection information.

​
customer
object

Customer information if available.

​
customerEmail
string<email>

Customer email if available.

​
customerPhone
string

Customer phone if available.

​
productVariant
object

Product variant information.

​
urlWithParams
string

Complete page URL with query parameters.

​
urlWithoutParams
string

Page URL without query parameters.

Response

Event processed successfully