@redotech/redo-api-schema 2.2.449 → 2.2.476

package/lib/openapi.d.ts

@@ -165,18 +165,53 @@ export interface paths {
      * @description Create a custom event to trigger flows with merchant-defined event names and properties.
      *
      * Custom events allow merchants to trigger flows based on events from their own systems.
-     * Events can include custom properties that are accessible in email and SMS templates.
+     * Events can include custom properties that are accessible in email and SMS templates,
+     * and are persisted for segmentation and historical queries.
      *
-     * ## Customer Matching
-     * The API matches customers by email or phone number. At least one must be provided.
+     * ## Identity Resolution
+     * The API resolves customers using the following priority order:
+     * 1. `customer.id` — Redo customer ObjectId (highest priority)
+     * 2. `customer.email` — customer email address
+     * 3. `customer.phoneNumber` — customer phone number
      *
-     * If no matching customer is found, the request will fail with a 404 error.
+     * At least one identifier must be provided. If no matching customer is found, one will
+     * be created automatically. If `customer.id` is provided but not found, the API falls
+     * back to email/phone rather than returning 404.
+     *
+     * ## Datetime Formatting
+     * All datetime values must be formatted as ISO 8601 (RFC 3339) strings, e.g., `2026-04-02T12:00:00Z`.
+     * This applies to `eventTimestamp`, any date-valued properties in `data`, and any date-valued `customFields`.
+     * Strings matching this format are automatically detected and indexed as dates for segmentation.
      *
      * ## Rate Limiting
      * This endpoint is rate-limited to 100 requests per second per store.
      */
     post: operations["Custom event create"];
   };
+  "/stores/{storeId}/events/bulk": {
+    /**
+     * Bulk create custom events
+     * @description Create multiple custom events in a single request. Accepts up to 100 events per request.
+     *
+     * Each event is validated independently. The response includes per-event results, allowing
+     * partial failures — some events may be accepted while others are rejected due to validation
+     * errors.
+     *
+     * ## Identity Resolution
+     * Each event resolves customers independently using the same priority order as the
+     * single-event endpoint:
+     * 1. `customer.id` — Redo customer ObjectId (highest priority)
+     * 2. `customer.email` — customer email address
+     * 3. `customer.phoneNumber` — customer phone number
+     *
+     * At least one identifier must be provided per event. If no matching customer is found,
+     * one will be created automatically.
+     *
+     * ## Rate Limiting
+     * This endpoint is rate-limited to 100 requests per second per store.
+     */
+    post: operations["Bulk create custom events"];
+  };
   "/stores/{storeId}/invoices": {
     /**
      * List Invoices
@@ -392,6 +427,14 @@ export interface components {
        */
       state: string;
     };
+    /**
+     * Bulk Custom Event Request
+     * @description Request body for sending multiple custom events in a single request.
+     */
+    "bulk-custom-event-request.schema": {
+      /** @description Array of custom events to create. */
+      events: components["schemas"]["custom-event-request.schema"][];
+    };
     /**
      * Product Family Image
      * @description An image associated with a product family or variant.
@@ -795,49 +838,77 @@ export interface components {
      * @description Custom event to trigger flows with merchant-defined event names and properties.
      */
     "custom-event-request.schema": {
-      /** @description Cart context for product recommendations in triggered emails. If not provided, no cart-aware recommendations will be made. */
-      cart_context?: ({
-        /** @description Items already in the customer's cart. */
-        alreadyInCart: {
-            productId: string;
-            quantity?: number;
-            variantId: string;
-          }[];
-        /** @description The ID of an existing cart to use for recommendations. */
-        existingCartId: string | null;
-        /** @description Product IDs to use as the basis for recommendations. */
-        productIdsForRecommendations: string[];
-      }) | null;
-      /** @description Customer email address (one of email or phone is required). */
-      email?: string;
-      /** @description The name of the custom event (e.g., 'user_registered', 'purchase_completed'). */
-      event_name: string;
-      /**
-       * Format: date-time
-       * @description ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
+      /** @description Customer identity and profile fields. At least one of `id`, `email`, or `phoneNumber` is required for identity resolution. */
+      customer: {
+        /** @description Merchant-defined customer attributes as key-value pairs. Values can be strings, numbers, or booleans. Date values should be passed as ISO 8601 strings (e.g., "2026-04-02T12:00:00Z") and are automatically detected and indexed as dates. */
+        customFields?: {
+          [key: string]: string | number | boolean;
+        };
+        /**
+         * Format: email
+         * @description Customer email address. Used for identity resolution.
+         */
+        email?: string;
+        /** @description Customer first name. Applied with patch semantics — does not erase existing value if omitted. */
+        firstName?: string;
+        /** @description Redo customer ObjectId. Used for identity resolution. Takes priority over email and phoneNumber when provided. */
+        id?: string;
+        /** @description Customer last name. Applied with patch semantics — does not erase existing value if omitted. */
+        lastName?: string;
+        /** @description Customer location for profile enrichment. All fields are optional. */
+        location?: {
+          /** @description City name. */
+          city?: string;
+          /** @description Country name. */
+          country?: string;
+          /** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB"). */
+          countryCode?: string;
+          /** @description IANA time zone identifier (e.g., "America/New_York"). */
+          ianaTimeZoneName?: string;
+          /** @description Geographic latitude coordinate. */
+          latitude?: number;
+          /** @description Geographic longitude coordinate. */
+          longitude?: number;
+          /** @description Postal or ZIP code. */
+          postalCode?: string;
+          /** @description State or province name. */
+          state?: string;
+          /** @description State or province abbreviation (e.g., "CA", "NY"). */
+          stateCode?: string;
+          /** @description Primary street address. */
+          street1?: string;
+          /** @description Secondary address line (apartment, suite, etc.). */
+          street2?: string;
+        };
+        /** @description Customer phone number in E.164 format. Used for identity resolution. */
+        phoneNumber?: string;
+      };
+      /**
+       * @description Custom properties for this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB, and each string cannot be larger than 100 KB. For a full list of data limits on event payloads, see [Limitations](/docs/guides/integrations/custom-events#rate-limits).
+       *
+       * Note any top-level property that is not an object can be used to create segments. The `$extra` property records any non-segmentable values that can be referenced later, e.g., HTML templates are useful on a segment but are not used to create a segment.
        */
-      event_timestamp?: string;
-      /** @description Customer phone number (one of email or phone is required). */
-      phone?: string;
-      /** @description Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}). */
-      properties?: {
-        [key: string]: unknown;
+      data?: {
+        /** @description Non-segmentable metadata bucket. Values inside `$extra` are stored on the event but excluded from segmentation indexes. Unlike top-level data properties, values of 0, null, and empty string are NOT stripped inside `$extra`. Use this for large text, debug info, nested objects, arrays, or any data you want to reference in templates but not segment on. */
+        $extra?: {
+          [key: string]: unknown;
+        };
+        [key: string]: (string | number | boolean) | undefined;
       };
-    };
-    /**
-     * Custom Event Response
-     * @description Response after successfully creating a custom event.
-     */
-    "custom-event-response.schema": {
-      /** @description The unique identifier for the created event. */
-      event_id: string;
-      /** @description The name of the custom event that was created. */
-      event_name: string;
+      /** @description The name of the custom event (e.g., 'User Registered', 'Loyalty Reward Earned'). */
+      eventName: string;
       /**
-       * @description Status of the event processing.
-       * @enum {string}
+       * Format: date-time
+       * @description ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
        */
-      status: "processed";
+      eventTimestamp?: string;
+      /** @description Merchant-controlled deduplication key (1-255 characters). If provided, subsequent events with the same uniqueId for the same store are silently deduplicated. Use this for safe retries and at-least-once delivery patterns. */
+      uniqueId?: string;
+      /** @description Monetary or conversion value associated with the event (e.g., purchase amount). */
+      value?: number;
+      /** @description ISO 4217 currency code for the value field (e.g., "USD", "EUR"). */
+      valueCurrency?: string;
+      [key: string]: unknown;
     };
     /**
      * Customer Location
@@ -2918,12 +2989,23 @@ export interface operations {
    * @description Create a custom event to trigger flows with merchant-defined event names and properties.
    *
    * Custom events allow merchants to trigger flows based on events from their own systems.
-   * Events can include custom properties that are accessible in email and SMS templates.
+   * Events can include custom properties that are accessible in email and SMS templates,
+   * and are persisted for segmentation and historical queries.
+   *
+   * ## Identity Resolution
+   * The API resolves customers using the following priority order:
+   * 1. `customer.id` — Redo customer ObjectId (highest priority)
+   * 2. `customer.email` — customer email address
+   * 3. `customer.phoneNumber` — customer phone number
    *
-   * ## Customer Matching
-   * The API matches customers by email or phone number. At least one must be provided.
+   * At least one identifier must be provided. If no matching customer is found, one will
+   * be created automatically. If `customer.id` is provided but not found, the API falls
+   * back to email/phone rather than returning 404.
    *
-   * If no matching customer is found, the request will fail with a 404 error.
+   * ## Datetime Formatting
+   * All datetime values must be formatted as ISO 8601 (RFC 3339) strings, e.g., `2026-04-02T12:00:00Z`.
+   * This applies to `eventTimestamp`, any date-valued properties in `data`, and any date-valued `customFields`.
+   * Strings matching this format are automatically detected and indexed as dates for segmentation.
    *
    * ## Rate Limiting
    * This endpoint is rate-limited to 100 requests per second per store.
@@ -2940,19 +3022,80 @@ export interface operations {
       };
     };
     responses: {
-      /** @description Event created successfully */
-      200: {
+      /** @description Event accepted and queued for processing. No response body is returned. */
+      202: {
+        content: never;
+      };
+      /** @description Invalid request body or missing required customer identifier */
+      400: {
         content: {
-          "application/json": components["schemas"]["custom-event-response.schema"];
+          "application/json": components["schemas"]["error.schema"];
         };
       };
-      /** @description Invalid request body or missing required customer identifier */
+      /** @description Store not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Rate limit exceeded */
+      429: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Bulk create custom events
+   * @description Create multiple custom events in a single request. Accepts up to 100 events per request.
+   *
+   * Each event is validated independently. The response includes per-event results, allowing
+   * partial failures — some events may be accepted while others are rejected due to validation
+   * errors.
+   *
+   * ## Identity Resolution
+   * Each event resolves customers independently using the same priority order as the
+   * single-event endpoint:
+   * 1. `customer.id` — Redo customer ObjectId (highest priority)
+   * 2. `customer.email` — customer email address
+   * 3. `customer.phoneNumber` — customer phone number
+   *
+   * At least one identifier must be provided per event. If no matching customer is found,
+   * one will be created automatically.
+   *
+   * ## Rate Limiting
+   * This endpoint is rate-limited to 100 requests per second per store.
+   */
+  "Bulk create custom events": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["bulk-custom-event-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Bulk request accepted and queued for processing. No response body is returned. */
+      202: {
+        content: never;
+      };
+      /** @description Invalid request body (e.g., events array missing or exceeds 100 items) */
       400: {
         content: {
           "application/json": components["schemas"]["error.schema"];
         };
       };
-      /** @description Customer not found with provided identifier */
+      /** @description Store not found */
       404: {
         content: {
           "application/json": components["schemas"]["error.schema"];

package/lib/openapi.yaml

@@ -190,16 +190,28 @@ paths:
         Create a custom event to trigger flows with merchant-defined event names and properties.
 
         Custom events allow merchants to trigger flows based on events from their own systems.
-        Events can include custom properties that are accessible in email and SMS templates.
+        Events can include custom properties that are accessible in email and SMS templates,
+        and are persisted for segmentation and historical queries.
 
-        ## Customer Matching
-        The API matches customers by email or phone number. At least one must be provided.
+        ## Identity Resolution
+        The API resolves customers using the following priority order:
+        1. `customer.id` — Redo customer ObjectId (highest priority)
+        2. `customer.email` — customer email address
+        3. `customer.phoneNumber` — customer phone number
 
-        If no matching customer is found, the request will fail with a 404 error.
+        At least one identifier must be provided. If no matching customer is found, one will
+        be created automatically. If `customer.id` is provided but not found, the API falls
+        back to email/phone rather than returning 404.
+
+        ## Datetime Formatting
+        All datetime values must be formatted as ISO 8601 (RFC 3339) strings, e.g., `2026-04-02T12:00:00Z`.
+        This applies to `eventTimestamp`, any date-valued properties in `data`, and any date-valued `customFields`.
+        Strings matching this format are automatically detected and indexed as dates for segmentation.
 
         ## Rate Limiting
         This endpoint is rate-limited to 100 requests per second per store.
       operationId: Custom event create
+      x-express-openapi-disable-validation-middleware: true
       parameters:
         - $ref: '#/components/parameters/store-id.param'
       requestBody:
@@ -208,44 +220,173 @@ paths:
             schema:
               $ref: '#/components/schemas/custom-event-request.schema'
             examples:
-              user_registered:
-                summary: User registration event
+              full_example:
+                summary: Every field populated
                 value:
-                  event_name: user_registered
-                  email: customer@example.com
-                  properties:
-                    plan_type: premium
-                    referral_code: FRIEND123
-                    source: mobile_app
-              purchase_milestone:
-                summary: Purchase milestone event
+                  eventName: Purchase Milestone Reached
+                  customer:
+                    id: 665f1a2b3c4d5e6f7a8b9c0d
+                    email: stewart@example.com
+                    phoneNumber: '+11234567890'
+                    firstName: Stewart
+                    lastName: Thompson
+                    location:
+                      street1: 123 Main St
+                      street2: Apt 4B
+                      city: Seattle
+                      state: Washington
+                      stateCode: WA
+                      postalCode: '98101'
+                      country: United States
+                      countryCode: US
+                      ianaTimeZoneName: America/Los_Angeles
+                      latitude: 47.6062
+                      longitude: -122.3321
+                    customFields:
+                      Age at Signup: 25
+                      Birthday: '1976-07-04T12:00:00Z'
+                      Loyalty Tier: Gold
+                      Accepts Marketing: true
+                  eventTimestamp: '2026-04-02T12:00:00Z'
+                  value: 299.99
+                  valueCurrency: USD
+                  uniqueId: milestone-test-001
+                  data:
+                    Milestone Type: 100th_purchase
+                    Total Spent: 5000
+                    VIP Tier: gold
+                    Enrolled At: '2025-01-01T00:00:00Z'
+                    Campaign Source: email_drip
+                    Last Purchase Date: '2026-03-15T00:00:00Z'
+                    $extra:
+                      Most Recent Order IDs:
+                        - 1
+                        - 2
+                        - 3
+                      Profile Snapshot:
+                        tier: gold
+                        memberSince: '2024-01-01'
+              medium_example:
+                summary: Event with customer profile and data
                 value:
-                  event_name: purchase_milestone_reached
-                  phone: '+12065551234'
-                  properties:
-                    milestone_type: 100th_purchase
-                    total_spent: 5000
-                    vip_tier: gold
+                  eventName: Order Placed
+                  customer:
+                    email: stewart@example.com
+                    firstName: Stewart
+                    lastName: Thompson
+                    customFields:
+                      Birthday: '1976-07-04T12:00:00Z'
+                      Loyalty Tier: Gold
+                  value: 149.99
+                  valueCurrency: USD
+                  data:
+                    Order Id: ord_456
+                    Item Count: 3
+                    Category: apparel
+              minimal:
+                summary: Required fields only
+                value:
+                  eventName: Page Viewed
+                  customer:
+                    email: stewart@example.com
         required: true
       responses:
-        '200':
+        '202':
+          description: Event accepted and queued for processing. No response body is returned.
+        '400':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/custom-event-response.schema'
-          description: Event created successfully
+                $ref: '#/components/schemas/error.schema'
+          description: Invalid request body or missing required customer identifier
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Store not found
+        '429':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Rate limit exceeded
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Create custom event
+      tags:
+        - Custom Events
+  /stores/{storeId}/events/bulk:
+    post:
+      description: |
+        Create multiple custom events in a single request. Accepts up to 100 events per request.
+
+        Each event is validated independently. The response includes per-event results, allowing
+        partial failures — some events may be accepted while others are rejected due to validation
+        errors.
+
+        ## Identity Resolution
+        Each event resolves customers independently using the same priority order as the
+        single-event endpoint:
+        1. `customer.id` — Redo customer ObjectId (highest priority)
+        2. `customer.email` — customer email address
+        3. `customer.phoneNumber` — customer phone number
+
+        At least one identifier must be provided per event. If no matching customer is found,
+        one will be created automatically.
+
+        ## Rate Limiting
+        This endpoint is rate-limited to 100 requests per second per store.
+      operationId: Bulk create custom events
+      x-express-openapi-disable-validation-middleware: true
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bulk-custom-event-request.schema'
+            examples:
+              mixed_events:
+                summary: Bulk event creation with multiple event types
+                value:
+                  events:
+                    - eventName: User Registered
+                      customer:
+                        email: alice@example.com
+                      data:
+                        Plan Type: premium
+                    - eventName: Purchase Completed
+                      customer:
+                        email: bob@example.com
+                      data:
+                        Order Total: 99.99
+                        Item Count: 3
+                      value: 99.99
+                      valueCurrency: USD
+                      uniqueId: order-456
+        required: true
+      responses:
+        '202':
+          description: Bulk request accepted and queued for processing. No response body is returned.
         '400':
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/error.schema'
-          description: Invalid request body or missing required customer identifier
+          description: Invalid request body (e.g., events array missing or exceeds 100 items)
         '404':
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/error.schema'
-          description: Customer not found with provided identifier
+          description: Store not found
         '429':
           content:
             application/json:
@@ -260,7 +401,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Create custom event
+      summary: Bulk create custom events
       tags:
         - Custom Events
   /stores/{storeId}/customer-portal:
@@ -1921,83 +2062,141 @@ components:
       title: Coverage product
       type: object
     custom-event-request.schema:
-      additionalProperties: false
-      description: Custom event to trigger flows with merchant-defined event names and properties.
+      additionalProperties: true
+      description: |
+        Custom event to trigger flows with merchant-defined event names and properties.
       properties:
-        event_name:
-          description: The name of the custom event (e.g., 'user_registered', 'purchase_completed').
-          type: string
-        email:
-          description: Customer email address (one of email or phone is required).
-          type: string
-        phone:
-          description: Customer phone number (one of email or phone is required).
+        eventName:
+          description: The name of the custom event (e.g., 'User Registered', 'Loyalty Reward Earned').
           type: string
-        properties:
-          description: Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}).
+        customer:
+          description: |
+            Customer identity and profile fields. At least one of `id`, `email`, or `phoneNumber` is required for identity resolution.
+          type: object
+          additionalProperties: false
+          anyOf:
+            - required:
+                - id
+            - required:
+                - email
+            - required:
+                - phoneNumber
+          properties:
+            id:
+              description: Redo customer ObjectId. Used for identity resolution. Takes priority over email and phoneNumber when provided.
+              type: string
+            email:
+              description: Customer email address. Used for identity resolution.
+              format: email
+              type: string
+            phoneNumber:
+              description: Customer phone number in E.164 format. Used for identity resolution.
+              type: string
+            firstName:
+              description: Customer first name. Applied with patch semantics — does not erase existing value if omitted.
+              type: string
+            lastName:
+              description: Customer last name. Applied with patch semantics — does not erase existing value if omitted.
+              type: string
+            location:
+              description: Customer location for profile enrichment. All fields are optional.
+              type: object
+              additionalProperties: false
+              properties:
+                street1:
+                  description: Primary street address.
+                  type: string
+                street2:
+                  description: Secondary address line (apartment, suite, etc.).
+                  type: string
+                city:
+                  description: City name.
+                  type: string
+                state:
+                  description: State or province name.
+                  type: string
+                stateCode:
+                  description: State or province abbreviation (e.g., "CA", "NY").
+                  type: string
+                postalCode:
+                  description: Postal or ZIP code.
+                  type: string
+                country:
+                  description: Country name.
+                  type: string
+                countryCode:
+                  description: ISO 3166-1 alpha-2 country code (e.g., "US", "GB").
+                  type: string
+                ianaTimeZoneName:
+                  description: IANA time zone identifier (e.g., "America/New_York").
+                  type: string
+                latitude:
+                  description: Geographic latitude coordinate.
+                  type: number
+                longitude:
+                  description: Geographic longitude coordinate.
+                  type: number
+            customFields:
+              description: |
+                Merchant-defined customer attributes as key-value pairs. Values can be strings, numbers, or booleans. Date values should be passed as ISO 8601 strings (e.g., "2026-04-02T12:00:00Z") and are automatically detected and indexed as dates.
+              type: object
+              additionalProperties:
+                oneOf:
+                  - type: string
+                  - type: number
+                  - type: boolean
+        data:
+          description: |
+            Custom properties for this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB, and each string cannot be larger than 100 KB. For a full list of data limits on event payloads, see [Limitations](/docs/guides/integrations/custom-events#rate-limits).
+
+            Note any top-level property that is not an object can be used to create segments. The `$extra` property records any non-segmentable values that can be referenced later, e.g., HTML templates are useful on a segment but are not used to create a segment.
           type: object
-          additionalProperties: true
-        event_timestamp:
+          additionalProperties:
+            description: |
+              Segmentable event property. Each key you add becomes available for audience segmentation and automation conditions. Supported types are string, number, boolean, and date (ISO 8601 strings like "2025-01-15T00:00:00Z" are auto-detected as dates). Values of 0, null, and empty string ("") are treated as unset and will not be stored.
+            anyOf:
+              - type: string
+              - type: number
+              - type: boolean
+          properties:
+            $extra:
+              description: |
+                Non-segmentable metadata bucket. Values inside `$extra` are stored on the event but excluded from segmentation indexes. Unlike top-level data properties, values of 0, null, and empty string are NOT stripped inside `$extra`. Use this for large text, debug info, nested objects, arrays, or any data you want to reference in templates but not segment on.
+              type: object
+              additionalProperties: true
+        eventTimestamp:
           description: ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
           format: date-time
           type: string
-        cart_context:
-          description: Cart context for product recommendations in triggered emails. If not provided, no cart-aware recommendations will be made.
-          nullable: true
-          type: object
-          properties:
-            existingCartId:
-              description: The ID of an existing cart to use for recommendations.
-              type: string
-              nullable: true
-            productIdsForRecommendations:
-              description: Product IDs to use as the basis for recommendations.
-              type: array
-              items:
-                type: string
-            alreadyInCart:
-              description: Items already in the customer's cart.
-              type: array
-              items:
-                type: object
-                properties:
-                  productId:
-                    type: string
-                  variantId:
-                    type: string
-                  quantity:
-                    type: number
-                required:
-                  - productId
-                  - variantId
-          required:
-            - existingCartId
-            - productIdsForRecommendations
-            - alreadyInCart
+        value:
+          description: Monetary or conversion value associated with the event (e.g., purchase amount).
+          type: number
+        valueCurrency:
+          description: ISO 4217 currency code for the value field (e.g., "USD", "EUR").
+          type: string
+        uniqueId:
+          description: |
+            Merchant-controlled deduplication key (1-255 characters). If provided, subsequent events with the same uniqueId for the same store are silently deduplicated. Use this for safe retries and at-least-once delivery patterns.
+          type: string
       required:
-        - event_name
+        - eventName
+        - customer
       title: Custom Event Request
       type: object
-    custom-event-response.schema:
+    bulk-custom-event-request.schema:
       additionalProperties: false
-      description: Response after successfully creating a custom event.
+      description: Request body for sending multiple custom events in a single request.
       properties:
-        event_id:
-          description: The unique identifier for the created event.
-          type: string
-        status:
-          description: Status of the event processing.
-          enum:
-            - processed
-          type: string
-        event_name:
-          description: The name of the custom event that was created.
-          type: string
+        events:
+          description: Array of custom events to create.
+          type: array
+          items:
+            $ref: '#/components/schemas/custom-event-request.schema'
+          maxItems: 100
+          minItems: 1
       required:
-        - event_id
-        - status
-        - event_name
-      title: Custom Event Response
+        - events
+      title: Bulk Custom Event Request
       type: object
     subscription-status-marketing.schema:
       description: Marketing subscription status

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.449"
+  "version": "2.2.476"
 }