@redotech/redo-api-schema 2.2.137 → 2.2.146

package/lib/openapi.d.ts

@@ -155,6 +155,13 @@ export interface paths {
       };
     };
   };
+  "/stores/{storeId}/storefront/events": {
+    /**
+     * Receive storefront events
+     * @description Processes events from storefronts using Shopify pixel event schema
+     */
+    post: operations["storefrontEvent"];
+  };
   "/stores/{storeId}/webhooks": {
     /**
      * List webhooks
@@ -946,6 +953,68 @@ export interface components {
        */
       id: string;
     };
+    /**
+     * Storefront Event
+     * @description Shopify pixel event for storefront tracking.
+     */
+    "storefront-event.schema": ({
+      /** @description Anonymous identifier for users without account. */
+      anonymousId?: string;
+      /** @description Cart information. */
+      cart?: Record<string, never> | null;
+      /** @description Information about specific cart line item. */
+      cartLine?: Record<string, never>;
+      /** @description Checkout information. */
+      checkout?: Record<string, never>;
+      /** @description Collection information. */
+      collection?: Record<string, never>;
+      /** @description Customer information if available. */
+      customer?: Record<string, never> | null;
+      /**
+       * Format: email
+       * @description Customer email if available.
+       */
+      customerEmail?: string;
+      /** @description Customer phone if available. */
+      customerPhone?: string;
+      /** @description Unique identifier for the event. */
+      eventId?: string;
+      /**
+       * @description Name of the Shopify pixel event.
+       * @enum {string}
+       */
+      eventName?: "product_added_to_cart" | "product_removed_from_cart" | "product_viewed" | "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted" | "page_viewed" | "collection_viewed";
+      /** @description Product variant information. */
+      productVariant?: Record<string, never>;
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp when the event occurred.
+       */
+      timestamp?: string;
+      /** @description Page URL without query parameters. */
+      urlWithoutParams?: string;
+      /** @description Complete page URL with query parameters. */
+      urlWithParams?: string;
+      [key: string]: unknown;
+    }) & ({
+      /** @enum {unknown} */
+      eventName?: "product_added_to_cart";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "product_removed_from_cart";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "product_viewed";
+    } | ({
+      /** @enum {unknown} */
+      eventName?: "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted";
+    }) | {
+      /** @enum {unknown} */
+      eventName?: "page_viewed";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "collection_viewed";
+    });
     /**
      * Webhook create
      * @description Webhook create.
@@ -1609,6 +1678,40 @@ export interface operations {
       };
     };
   };
+  /**
+   * Receive storefront events
+   * @description Processes events from storefronts using Shopify pixel event schema
+   */
+  storefrontEvent: {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["storefront-event.schema"];
+      };
+    };
+    responses: {
+      /** @description Event processed successfully */
+      204: {
+        content: never;
+      };
+      /** @description Invalid event payload */
+      400: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * List webhooks
    * @description List webhooks for store.

package/lib/openapi.yaml

@@ -1044,6 +1044,118 @@ components:
         - id
       title: Storefront Customer
       type: object
+    storefront-event.schema:
+      additionalProperties: true
+      allOf:
+        - required:
+            - eventName
+            - eventId
+            - timestamp
+        - oneOf:
+            - required:
+                - customer
+            - required:
+                - anonymousId
+      description: Shopify pixel event for storefront tracking.
+      oneOf:
+        - properties:
+            eventName:
+              enum:
+                - product_added_to_cart
+          required:
+            - cartLine
+            - cart
+        - properties:
+            eventName:
+              enum:
+                - product_removed_from_cart
+          required:
+            - cartLine
+            - cart
+        - properties:
+            eventName:
+              enum:
+                - product_viewed
+          required:
+            - productVariant
+        - properties:
+            eventName:
+              enum:
+                - checkout_started
+                - checkout_completed
+                - checkout_contact_info_submitted
+          required:
+            - checkout
+        - properties:
+            eventName:
+              enum:
+                - page_viewed
+        - properties:
+            eventName:
+              enum:
+                - collection_viewed
+          required:
+            - collection
+      properties:
+        anonymousId:
+          description: Anonymous identifier for users without account.
+          type: string
+        cart:
+          description: Cart information.
+          type:
+            - object
+            - 'null'
+        cartLine:
+          description: Information about specific cart line item.
+          type: object
+        checkout:
+          description: Checkout information.
+          type: object
+        collection:
+          description: Collection information.
+          type: object
+        customer:
+          description: Customer information if available.
+          type:
+            - object
+            - 'null'
+        customerEmail:
+          description: Customer email if available.
+          format: email
+          type: string
+        customerPhone:
+          description: Customer phone if available.
+          type: string
+        eventId:
+          description: Unique identifier for the event.
+          type: string
+        eventName:
+          description: Name of the Shopify pixel event.
+          enum:
+            - product_added_to_cart
+            - product_removed_from_cart
+            - product_viewed
+            - checkout_started
+            - checkout_completed
+            - checkout_contact_info_submitted
+            - page_viewed
+            - collection_viewed
+          type: string
+        productVariant:
+          description: Product variant information.
+          type: object
+        timestamp:
+          description: ISO 8601 timestamp when the event occurred.
+          format: date-time
+          type: string
+        urlWithParams:
+          description: Complete page URL with query parameters.
+          type: string
+        urlWithoutParams:
+          description: Page URL without query parameters.
+          type: string
+      title: Storefront Event
+      type: object
     webhook-create.schema:
       description: Webhook create.
       properties:
@@ -1787,6 +1899,38 @@ paths:
     parameters:
       - $ref: '#/components/parameters/store-id.param'
     summary: Shipment Document
+  /stores/{storeId}/storefront/events:
+    post:
+      description: Processes events from storefronts using Shopify pixel event schema
+      operationId: storefrontEvent
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/storefront-event.schema'
+        required: true
+      responses:
+        '204':
+          description: Event processed successfully
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Invalid event payload
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Receive storefront events
+      tags:
+        - Storefront
   /stores/{storeId}/webhooks:
     description: Webhooks.
     get:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.137"
+  "version": "2.2.146"
 }