@redotech/redo-api-schema 2.2.331 → 2.2.416

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
@@ -158,42 +191,6 @@ export interface paths {
       };
     };
   };
-  "/stores/{storeId}/shipments/{shipmentId}/documents/{documentType}": {
-    /**
-     * Download Shipment Document
-     * @description Get a shipment document (label, commercial invoice, etc).
-     */
-    get: operations["Shipment document download"];
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
-  };
-  "/stores/{storeId}/shipments/buy": {
-    /**
-     * Purchase Shipping Label
-     * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
-     */
-    post: operations["Shipment buy"];
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
-  };
-  "/stores/{storeId}/shipments/rates": {
-    /**
-     * Shipping Rates
-     * @description Get available shipping rates based on origin, destination, and parcel information.
-     */
-    post: operations["Shipment rates"];
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
-  };
   "/stores/{storeId}/storefront/events": {
     /**
      * Receive Storefront Events
@@ -379,6 +376,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": {
       /**
@@ -419,6 +480,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).
@@ -628,23 +731,6 @@ export interface components {
        */
       total: components["schemas"]["money.schema"];
     };
-    /**
-     * Parcel Type
-     * @description Parcel type enum.
-     * @enum {string}
-     */
-    "parcel-type.schema": "box" | "envelope" | "soft_pack";
-    /**
-     * Parcel
-     * @description Parcel information for shipping.
-     */
-    "parcel.schema": {
-      height: components["schemas"]["length.schema"];
-      length: components["schemas"]["length.schema"];
-      type: components["schemas"]["parcel-type.schema"];
-      weight: components["schemas"]["shipping-weight.schema"];
-      width: components["schemas"]["length.schema"];
-    };
     /**
      * Person name
      * @description Person name.
@@ -697,6 +783,11 @@ export interface components {
        * @description Array of compensation methods available for this return
        */
       compensationMethods?: ("refund" | "store_credit" | "exchange")[];
+      /**
+       * Complete With No Action
+       * @description Whether this return can be completed with no action
+       */
+      completeWithNoAction?: boolean;
       /**
        * Created at
        * Format: date-time
@@ -861,6 +952,11 @@ export interface components {
               name?: string;
             };
           };
+          /**
+           * External Return Line Item ID
+           * @description External return line item ID
+           */
+          externalReturnLineItemId?: string;
           /** @description Whether this is a green return (no physical return required) */
           greenReturn?: boolean;
           /**
@@ -912,6 +1008,11 @@ export interface components {
             /** @description Refund strategy */
             type?: string;
           };
+          /**
+           * Shipment Group IDs
+           * @description IDs of the shipment groups this return item belongs to
+           */
+          shipmentGroupIds?: string[];
           /** @description Product SKU */
           sku?: string;
           /** @description Return item status */
@@ -942,10 +1043,15 @@ export interface components {
       order: {
         /**
          * ID
-         * @description Order ID.
-         * @example abc123
+         * @description Redo's internal identifier for the original order created in Redo.
+         * @example 64e4da943dd822979a70bd12
          */
         id: string;
+        /**
+         * Name
+         * @description Order name from the external provider, such as the Shopify order name.
+         */
+        name?: string;
       };
       /**
        * Shipment
@@ -990,6 +1096,16 @@ export interface components {
        * @description Return status.
        */
       status: components["schemas"]["return-status.schema"];
+      /**
+       * Tags
+       * @description Tags associated with this return
+       */
+      tags?: {
+          /** @description The tag's display name */
+          name: string;
+          /** @description The source of the tag */
+          source: string;
+        }[];
       /**
        * Totals
        * @description Calculated totals for the return
@@ -1034,11 +1150,41 @@ export interface components {
        * @description Carrier code
        */
       carrier?: string;
+      /**
+       * Delivered At
+       * @description Date and time this shipment was delivered
+       */
+      deliveredAt?: string;
+      /**
+       * Estimated Delivery Date
+       * @description Estimated delivery date for this shipment
+       */
+      estimatedDeliveryDate?: string;
+      /**
+       * External Location ID
+       * @description External location ID for the destination of this shipment
+       */
+      externalLocationId?: string;
+      /**
+       * Form Label
+       * @description Form label URL
+       */
+      formLabel?: string;
+      /**
+       * Item IDs
+       * @description IDs of the return items included in this shipment
+       */
+      itemIds?: string[];
       /**
        * Postage Label
        * @description Postage label URL
        */
       postageLabel?: string;
+      /**
+       * Shipment Group ID
+       * @description ID of the shipment group this shipment belongs to
+       */
+      shipmentGroupId?: string;
       /**
        * Status
        * @description Status of shipment
@@ -1097,108 +1243,6 @@ export interface components {
      * @enum {string}
      */
     "return-type.schema": "claim" | "return" | "warranty";
-    /**
-     * Shipment Document Type
-     * @description Type of shipping document.
-     * @enum {string}
-     */
-    "shipment-document-type.schema": "label" | "commercialInvoice";
-    /**
-     * Shipment Document
-     * @description Shipping document information.
-     */
-    "shipment-document.schema": {
-      type: components["schemas"]["shipment-document-type.schema"];
-    };
-    /**
-     * Shipment Rate
-     * @description Shipping rate information.
-     */
-    "shipment-rate.schema": {
-      carrier: {
-        /**
-         * Carrier Account ID
-         * @description ID for the carrier account that provides the shipping rate.
-         */
-        id: string;
-        /**
-         * Carrier Name
-         * @description Carrier display name
-         */
-        name: string;
-      };
-      price: components["schemas"]["money.schema"];
-      service: {
-        /**
-         * Service Name
-         * @description Service level name
-         */
-        name: string;
-      };
-    };
-    /**
-     * Shipment Tracker
-     * @description Shipment tracking information.
-     */
-    "shipment-tracker.schema": {
-      /**
-       * Tracking Code
-       * @description Carrier tracking code
-       */
-      code: string;
-    };
-    /**
-     * Shipment
-     * @description Shipment information.
-     */
-    "shipment.schema": {
-      /**
-       * Documents
-       * @description Available shipping documents. You can access these documents using the GET Shipment document endpoint.
-       */
-      documents: components["schemas"]["shipment-document.schema"][];
-      /**
-       * Shipment ID
-       * @description Shipment identifier
-       */
-      id: string;
-      price: components["schemas"]["money.schema"];
-      tracker: components["schemas"]["shipment-tracker.schema"];
-    };
-    /**
-     * Shipping Contact
-     * @description Contact information for shipping.
-     */
-    "shipping-contact.schema": {
-      address: components["schemas"]["address.schema"];
-      /**
-       * Name
-       * @description Contact name
-       */
-      name: string;
-      /**
-       * Phone Number
-       * @description Contact phone number
-       */
-      phoneNumber: string;
-    };
-    /**
-     * Shipping Weight
-     * @description Weight measurement with unit for shipping.
-     */
-    "shipping-weight.schema": {
-      /**
-       * Unit
-       * @description Weight unit
-       * @enum {string}
-       */
-      unit: "g" | "kg" | "oz" | "lb";
-      /**
-       * Value
-       * @description Numeric weight value
-       */
-      value: number;
-    };
     /**
      * Storefront Cart
      * @description Storefront cart.
@@ -1318,7 +1362,10 @@ export interface components {
       urlWithParams?: string;
       [key: string]: unknown;
     };
-    /** @description Marketing subscription status */
+    /**
+     * Subscription Status Marketing
+     * @description Marketing subscription status
+     */
     "subscription-status-marketing.schema": {
       /**
        * @description Subscription status
@@ -1336,7 +1383,10 @@ export interface components {
        */
       updatedAt?: string;
     };
-    /** @description Transactional subscription status (order tracking) */
+    /**
+     * Subscription Status Transactional
+     * @description Transactional subscription status (order tracking)
+     */
     "subscription-status-transactional.schema": {
       /**
        * @description Subscription status. Only subscribed and unsubscribed are supported for transactional.
@@ -1469,8 +1519,6 @@ export interface components {
   };
   responses: never;
   parameters: {
-    /** @description Type of document to download */
-    "document-type.param": components["schemas"]["shipment-document-type.schema"];
     /** @description Invoice ID */
     "invoice-id.param": string;
     /**
@@ -1487,8 +1535,8 @@ export interface components {
     "provider-order-name"?: string;
     /** @description Return ID */
     "return-id.param": string;
-    /** @description Shipment ID */
-    "shipment-id.param": string;
+    /** @description Filter returns by status */
+    "return-status.param"?: components["schemas"]["return-status.schema"];
     /** @description Shopify specific order name */
     "shopify-order-name"?: string;
     /** @description Store ID */
@@ -1854,6 +1902,7 @@ export interface operations {
           customer?: components["schemas"]["storefront-customer.schema"];
           /**
            * Products
+           * @deprecated
            * @description Product information.
            */
           products?: {
@@ -1865,6 +1914,7 @@ export interface operations {
             }[];
           /**
            * Variants
+           * @deprecated
            * @description Variant information.
            */
           variants?: {
@@ -1988,6 +2038,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.
@@ -2085,6 +2251,7 @@ export interface operations {
         updated_at_min?: components["parameters"]["updated-at-min.param"];
         shopify_order_name?: components["parameters"]["shopify-order-name"];
         provider_order_name?: components["parameters"]["provider-order-name"];
+        status?: components["parameters"]["return-status.param"];
       };
       header?: {
         "X-Page-Continue"?: components["parameters"]["page-continue.param"];
@@ -2115,122 +2282,6 @@ export interface operations {
       };
     };
   };
-  /**
-   * Download Shipment Document
-   * @description Get a shipment document (label, commercial invoice, etc).
-   */
-  "Shipment document download": {
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-        shipmentId: components["parameters"]["shipment-id.param"];
-        documentType: components["parameters"]["document-type.param"];
-      };
-    };
-    responses: {
-      /** @description Success */
-      200: {
-        content: {
-          "application/pdf": string;
-          "image/png": string;
-        };
-      };
-      /** @description Error */
-      default: {
-        content: {
-          "application/problem+json": components["schemas"]["error.schema"];
-        };
-      };
-    };
-  };
-  /**
-   * Purchase Shipping Label
-   * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
-   */
-  "Shipment buy": {
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
-    requestBody: {
-      content: {
-        "application/json": {
-          carrier: {
-            /**
-             * Carrier Account ID
-             * @description ID for the carrier account that provides the shipping rate.
-             */
-            id: string;
-          };
-          destination: components["schemas"]["shipping-contact.schema"];
-          origin: components["schemas"]["shipping-contact.schema"];
-          parcel: components["schemas"]["parcel.schema"];
-          service: {
-            /** @description Service level name */
-            name: string;
-          };
-        };
-      };
-    };
-    responses: {
-      /** @description Success */
-      200: {
-        content: {
-          "application/json": {
-            shipment: components["schemas"]["shipment.schema"];
-          };
-        };
-      };
-      /** @description Error */
-      default: {
-        content: {
-          "application/problem+json": components["schemas"]["error.schema"];
-        };
-      };
-    };
-  };
-  /**
-   * Shipping Rates
-   * @description Get available shipping rates based on origin, destination, and parcel information.
-   */
-  "Shipment rates": {
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
-    requestBody: {
-      content: {
-        "application/json": {
-          destination: {
-            address: components["schemas"]["address.schema"];
-          };
-          origin: {
-            address: components["schemas"]["address.schema"];
-          };
-          parcel: components["schemas"]["parcel.schema"];
-        };
-      };
-    };
-    responses: {
-      /** @description Success */
-      200: {
-        content: {
-          "application/json": {
-            /** @description Available shipping rates */
-            rates: components["schemas"]["shipment-rate.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