@redotech/redo-api-schema 2.2.405 → 2.2.418

package/lib/openapi.d.ts

@@ -121,6 +121,39 @@ export interface paths {
      */
     post: operations["Customer subscriptions update"];
   };
+  "/stores/{storeId}/customers": {
+    /**
+     * Get customer by email
+     * @description Retrieve a customer profile by email address.
+     *
+     * The response includes the customer's name, contact information, location,
+     * and any custom fields associated with the profile. Custom fields are returned
+     * as `{ fieldName: value }` pairs.
+     */
+    get: operations["Customer get"];
+    /**
+     * Create or update customer
+     * @description Create or update a customer profile. Uses the email address as the upsert
+     * key — if a customer with that email exists, their profile is updated;
+     * otherwise, a new customer is created.
+     *
+     * ## Profile fields
+     * - `firstName` and `lastName` are set directly on the customer. A full
+     *   display name is automatically generated from these fields.
+     * - `phoneNumber` should be in E.164 format (e.g., `+12345678900`). If the
+     *   number is new, it is added to the customer's contact information.
+     *
+     * ## Location
+     * Providing `location` sets the customer's current location. Only the fields
+     * you include are updated.
+     *
+     * ## Custom fields
+     * Use `customFields` to store arbitrary key-value data on the customer (e.g.,
+     * `pricing_plan`, `subscription_source`). Values can be strings, numbers, or
+     * booleans. If a custom field doesn't exist yet, it is created automatically.
+     */
+    put: operations["Customer upsert"];
+  };
   "/stores/{storeId}/events": {
     /**
      * Create custom event
@@ -152,6 +185,11 @@ export interface paths {
      * @description List returns, sorted by most recent to least recent.
      */
     get: operations["Returns list"];
+    /**
+     * Create Return
+     * @description Create a return for specific order line items.
+     */
+    post: operations["Return create"];
     parameters: {
       path: {
         storeId: components["parameters"]["store-id.param"];
@@ -307,6 +345,83 @@ export interface components {
        */
       price: components["schemas"]["money.schema"];
     };
+    /** @description Create return request body. */
+    "create-return-request.schema": {
+      /** @description Return information payload. */
+      data: {
+        /** @description External order ID from the ecommerce platform. */
+        externalOrderId: string;
+        /** @description Items being returned. */
+        items: ({
+            /**
+             * @description How the customer should be compensated for this item.
+             * @enum {string}
+             */
+            compensation: "refund" | "store_credit";
+            /** @description External line item ID from the order. */
+            lineItemId: string;
+            /** @description Customer-facing notes for this item. */
+            notes?: string;
+            /** @description Number of units to return. */
+            quantity: number;
+            /** @description Customer-facing return reason. */
+            reason: string;
+            /** @description Machine-readable reason code. */
+            reasonCode?: string;
+          })[];
+        /** @description Optional return label and tracking details. */
+        label?: {
+          /** @description Carrier name. */
+          carrier?: string;
+          /** @description Commercial or form label URL. */
+          formLabelUrl?: string;
+          /** @description Provider shipment identifier to reference. */
+          originalShipmentId?: string;
+          /** @description Postage label URL. */
+          postageLabelUrl?: string;
+          /** @description Carrier tracking number. */
+          trackingNumber: string;
+          /** @description Public tracking URL. */
+          trackingUrl?: string;
+        };
+        /** @description Internal merchant-side notes. */
+        notes?: string;
+        /** @description Ecommerce platform provider. */
+        provider: string;
+        /** @description Address the customer is shipping from. */
+        shippingAddress: {
+          city: string;
+          /** @description ISO 3166-1 alpha-2 country code. */
+          country: string;
+          line1: string;
+          line2?: string;
+          postalCode: string;
+          state: string;
+        };
+      };
+      /** @description Options controlling side effects of the return creation. */
+      options?: {
+        /**
+         * @description Whether to create RMAs with external integrations (e.g. ShipBob). Defaults to false.
+         * @default false
+         */
+        createExternalRMAs?: boolean;
+      };
+    };
+    /** @description Create return response body. */
+    "create-return-response.schema": {
+      externalRMAResponses: {
+          /** @description Provider error code when external RMA creation fails. */
+          errorCode?: string;
+          /** @description Provider error message when external RMA creation fails. */
+          errorMessage?: string;
+          /** @description Name of the external integration provider. */
+          integrationProvider: string;
+          /** @description Whether external RMA creation succeeded. */
+          success: boolean;
+        }[];
+      return: components["schemas"]["return-read.schema"];
+    };
     /**
      * Custom Event Request
      * @description Custom event to trigger flows with merchant-defined event names and properties.
@@ -343,6 +458,70 @@ export interface components {
        */
       status: "processed";
     };
+    /**
+     * Customer Location
+     * @description Customer location information.
+     */
+    "customer-location.schema": {
+      /** @description City name */
+      city?: string;
+      /** @description Country name */
+      country?: string;
+      /** @description ISO 3166-1 alpha-2 country code */
+      countryCode?: string;
+      /** @description IANA time zone identifier */
+      ianaTimeZoneName?: string;
+      /** @description Latitude coordinate */
+      latitude?: number;
+      /** @description Longitude coordinate */
+      longitude?: number;
+      /** @description Postal or ZIP code */
+      postalCode?: string;
+      /** @description State or province name */
+      state?: string;
+      /** @description State or province abbreviation */
+      stateCode?: string;
+      /** @description Street address line 1 */
+      street1?: string;
+      /** @description Street address line 2 */
+      street2?: string;
+    };
+    /**
+     * Customer
+     * @description Customer profile.
+     */
+    "customer-read.schema": {
+      /**
+       * Created at
+       * Format: date-time
+       * @description Timestamp when the customer was created.
+       */
+      createdAt: string;
+      /** @description Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans. */
+      customFields?: {
+        [key: string]: string | number | boolean;
+      };
+      /**
+       * Format: email
+       * @description Customer email address
+       */
+      email: string;
+      /** @description Customer first name */
+      firstName?: string;
+      /** @description Redo customer ID */
+      id: string;
+      /** @description Customer last name */
+      lastName?: string;
+      location?: components["schemas"]["customer-location.schema"];
+      /** @description Customer phone number in E.164 format */
+      phoneNumber?: string;
+      /**
+       * Updated at
+       * Format: date-time
+       * @description Timestamp when the customer was last updated.
+       */
+      updatedAt: string;
+    };
     /** @description Email subscription updates */
     "customer-subscription-email.schema": {
       /**
@@ -383,6 +562,48 @@ export interface components {
         };
       };
     };
+    /**
+     * Customer Upsert Request
+     * @description Request body for creating or updating a customer profile. The email address is used as the upsert key.
+     */
+    "customer-upsert-request.schema": {
+      /**
+       * @description Custom field values as key-value pairs. Keys are field names and values can be strings, numbers, or booleans. New fields are created automatically if they don't exist yet.
+       * @example {
+       *   "subscription_source": "web",
+       *   "status": "Active",
+       *   "loyalty_points": 1250,
+       *   "vip_member": true
+       * }
+       */
+      customFields?: {
+        [key: string]: string | number | boolean;
+      };
+      /**
+       * Format: email
+       * @description Customer email address. Used as the upsert key to find or create the customer.
+       */
+      email: string;
+      /** @description Customer first name */
+      firstName?: string;
+      /** @description Customer last name */
+      lastName?: string;
+      location?: components["schemas"]["customer-location.schema"];
+      /** @description Customer phone number in E.164 format (e.g., +12345678900). Appended to the existing phone list if not already present. */
+      phoneNumber?: string;
+    };
+    /**
+     * Customer Upsert Response
+     * @description Response after creating or updating a customer profile.
+     */
+    "customer-upsert-response.schema": {
+      /** @description Whether a new customer was created (true) or an existing customer was updated (false). */
+      created: boolean;
+      /** @description Customer email address */
+      email: string;
+      /** @description Redo customer ID */
+      id: string;
+    };
     /**
      * Problem details
      * @description Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
@@ -1380,6 +1601,8 @@ export interface components {
   };
   responses: never;
   parameters: {
+    /** @description Optional idempotency key for safely retrying create requests. */
+    "idempotency-key.param"?: string;
     /** @description Invoice ID */
     "invoice-id.param": string;
     /**
@@ -1899,6 +2122,122 @@ export interface operations {
       };
     };
   };
+  /**
+   * Get customer by email
+   * @description Retrieve a customer profile by email address.
+   *
+   * The response includes the customer's name, contact information, location,
+   * and any custom fields associated with the profile. Custom fields are returned
+   * as `{ fieldName: value }` pairs.
+   */
+  "Customer get": {
+    parameters: {
+      query: {
+        /** @description Customer email address */
+        email: string;
+      };
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    responses: {
+      /** @description Customer found */
+      200: {
+        content: {
+          "application/json": components["schemas"]["customer-read.schema"];
+        };
+      };
+      /** @description Missing or invalid email parameter */
+      400: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description No customer found for that email */
+      404: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Internal server error */
+      500: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Create or update customer
+   * @description Create or update a customer profile. Uses the email address as the upsert
+   * key — if a customer with that email exists, their profile is updated;
+   * otherwise, a new customer is created.
+   *
+   * ## Profile fields
+   * - `firstName` and `lastName` are set directly on the customer. A full
+   *   display name is automatically generated from these fields.
+   * - `phoneNumber` should be in E.164 format (e.g., `+12345678900`). If the
+   *   number is new, it is added to the customer's contact information.
+   *
+   * ## Location
+   * Providing `location` sets the customer's current location. Only the fields
+   * you include are updated.
+   *
+   * ## Custom fields
+   * Use `customFields` to store arbitrary key-value data on the customer (e.g.,
+   * `pricing_plan`, `subscription_source`). Values can be strings, numbers, or
+   * booleans. If a custom field doesn't exist yet, it is created automatically.
+   */
+  "Customer upsert": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["customer-upsert-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Existing customer updated */
+      200: {
+        content: {
+          "application/json": components["schemas"]["customer-upsert-response.schema"];
+        };
+      };
+      /** @description New customer created */
+      201: {
+        content: {
+          "application/json": components["schemas"]["customer-upsert-response.schema"];
+        };
+      };
+      /** @description Invalid request body or invalid email address */
+      400: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Internal server error */
+      500: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Create custom event
    * @description Create a custom event to trigger flows with merchant-defined event names and properties.
@@ -2027,6 +2366,63 @@ export interface operations {
       };
     };
   };
+  /**
+   * Create Return
+   * @description Create a return for specific order line items.
+   */
+  "Return create": {
+    parameters: {
+      header?: {
+        "Idempotency-Key"?: components["parameters"]["idempotency-key.param"];
+      };
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["create-return-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Success (idempotent replay; existing return returned) */
+      200: {
+        content: {
+          "application/json": components["schemas"]["create-return-response.schema"];
+        };
+      };
+      /** @description Created */
+      201: {
+        content: {
+          "application/json": components["schemas"]["create-return-response.schema"];
+        };
+      };
+      /** @description Invalid request body */
+      400: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Order not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Conflict */
+      409: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Receive Storefront Events
    * @description Processes events from storefronts using Shopify pixel event schema