@redotech/redo-api-schema 2.2.134 → 2.2.144

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
@@ -727,6 +734,11 @@ export interface components {
        * @description Return status.
        */
       status: components["schemas"]["return-status.schema"];
+      /**
+       * Type
+       * @description Return type.
+       */
+      type?: components["schemas"]["return-type.schema"];
       /**
        * Updated at
        * Format: date-time
@@ -767,6 +779,14 @@ export interface components {
      * @enum {string}
      */
     "return-status.schema": "open" | "in_transit" | "delivered" | "needs_review" | "in_review" | "complete" | "rejected" | "flagged" | "pre_shipment" | "deleted";
+    /**
+     * Return type
+     * @description Return type.
+     *
+     * @example return
+     * @enum {string}
+     */
+    "return-type.schema": "claim" | "return" | "warranty";
     /**
      * Shipment Document Type
      * @description Type of shipping document.
@@ -933,6 +953,44 @@ export interface components {
        */
       id: string;
     };
+    /**
+     * Storefront Event
+     * @description Shopify pixel event for storefront tracking.
+     */
+    "storefront-event.schema": {
+      /** @description Cart information if relevant to the event. */
+      cart?: components["schemas"]["storefront-cart.schema"];
+      /** @description Identifier for the client that generated the event. */
+      clientId: string;
+      /** @description Customer information if available. */
+      customer?: components["schemas"]["storefront-customer.schema"];
+      /** @description Shopify customer ID if available. */
+      customerId?: string;
+      /** @description Unique identifier for the event. */
+      eventId: string;
+      /**
+       * @description Name of the Shopify pixel event (e.g., 'product_viewed', 'checkout_started').
+       * @enum {string}
+       */
+      eventName: "product_viewed" | "product_added" | "checkout_started" | "checkout_completed" | "page_viewed";
+      /** @description Additional context information. */
+      metadata?: {
+        [key: string]: unknown;
+      };
+      /** @description Product ID if event is related to a specific product. */
+      productId?: string;
+      /** @description Whether the Redo protection was selected in the UI. */
+      redoSelected?: boolean;
+      /** @description The Shopify shop domain. */
+      shopDomain: string;
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp when the event occurred.
+       */
+      timestamp: string;
+      /** @description Variant ID if event is related to a specific product variant. */
+      variantId?: string;
+    };
     /**
      * Webhook create
      * @description Webhook create.
@@ -1596,6 +1654,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

@@ -738,6 +738,10 @@ components:
           $ref: '#/components/schemas/return-status.schema'
           description: Return status.
           title: Status
+        type:
+          $ref: '#/components/schemas/return-type.schema'
+          description: Return type.
+          title: Type
         updatedAt:
           description: Time of last update.
           format: date-time
@@ -801,6 +805,16 @@ components:
       example: open
       title: Return status
       type: string
+    return-type.schema:
+      description: |
+        Return type.
+      enum:
+        - claim
+        - return
+        - warranty
+      example: return
+      title: Return type
+      type: string
     shipment-document-type.schema:
       description: Type of shipping document.
       enum:
@@ -1030,6 +1044,62 @@ components:
         - id
       title: Storefront Customer
       type: object
+    storefront-event.schema:
+      additionalProperties: false
+      description: Shopify pixel event for storefront tracking.
+      properties:
+        cart:
+          $ref: '#/components/schemas/storefront-cart.schema'
+          description: Cart information if relevant to the event.
+        clientId:
+          description: Identifier for the client that generated the event.
+          type: string
+        customer:
+          $ref: '#/components/schemas/storefront-customer.schema'
+          description: Customer information if available.
+        customerId:
+          description: Shopify customer ID if available.
+          type: string
+        eventId:
+          description: Unique identifier for the event.
+          type: string
+        eventName:
+          description: Name of the Shopify pixel event (e.g., 'product_viewed', 'checkout_started').
+          enum:
+            - product_viewed
+            - product_added
+            - checkout_started
+            - checkout_completed
+            - page_viewed
+          type: string
+        metadata:
+          additionalProperties: true
+          description: Additional context information.
+          type: object
+        productId:
+          description: Product ID if event is related to a specific product.
+          type: string
+        redoSelected:
+          description: Whether the Redo protection was selected in the UI.
+          type: boolean
+        shopDomain:
+          description: The Shopify shop domain.
+          type: string
+        timestamp:
+          description: ISO 8601 timestamp when the event occurred.
+          format: date-time
+          type: string
+        variantId:
+          description: Variant ID if event is related to a specific product variant.
+          type: string
+      required:
+        - eventName
+        - eventId
+        - timestamp
+        - clientId
+        - shopDomain
+      title: Storefront Event
+      type: object
     webhook-create.schema:
       description: Webhook create.
       properties:
@@ -1773,6 +1843,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.134"
+  "version": "2.2.144"
 }