Sign in

v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Storefront

Receive Storefront Events

Processes events from storefronts using Shopify pixel event schema Requires the storefront_events_write scope.

post/stores/{storeId}/storefront/events

Path parameters

storeIdstring required
Example:64e5a8a1af49a89df37e4ee7

Store ID

Request body

anonymousIdstring

Anonymous identifier for users without account.

cartobject nullable

Cart information.

cartLineobject

Information about specific cart line item.

checkoutobject

Checkout information.

collectionobject

Collection information.

customerobject nullable

Customer information if available.

customerEmailstring email

Customer email if available.

customerPhonestring

Customer phone if available.

eventIdstring required

Unique identifier for the event.

eventName'product_added_to_cart' | 'product_removed_from_cart' | 'product_viewed' | 'checkout_started' | 'checkout_completed' | 'checkout_contact_info_submitted' | 'page_viewed' | 'collection_viewed' required

Name of the Shopify pixel event.

productVariantobject

Product variant information.

source'AIMERCE' required

Source of the event.

timestampstring date-time required

ISO 8601 timestamp when the event occurred.

urlWithParamsstring

Complete page URL with query parameters.

urlWithoutParamsstring

Page URL without query parameters.

Response

Event processed successfully