@redotech/redo-api-schema 2.2.435 → 2.2.449

package/lib/openapi.d.ts

@@ -184,6 +184,71 @@ export interface paths {
      */
     get: operations["Invoice list"];
   };
+  "/stores/{storeId}/orders": {
+    /**
+     * Create Order
+     * @description Create a new order in the system with line items, customer information, and shipping details.
+     */
+    post: operations["Order create"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+  };
+  "/stores/{storeId}/orders/{orderId}": {
+    /**
+     * Get Order
+     * @description Retrieve an existing order from the system, including all fulfillments. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+     */
+    get: operations["Order get"];
+    /**
+     * Delete Order
+     * @description Delete an order from the system. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+     */
+    delete: operations["Order delete"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+      };
+    };
+  };
+  "/stores/{storeId}/orders/{orderId}/fulfillments": {
+    /**
+     * Create Fulfillment
+     * @description Create a fulfillment for specific line items within an order, including tracking information. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+     */
+    post: operations["Fulfillment create"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+      };
+    };
+  };
+  "/stores/{storeId}/orders/{orderId}/fulfillments/{fulfillmentId}/shipment-status": {
+    /**
+     * Update Fulfillment Status
+     * @description Post a shipment status update or trigger an automation event for a fulfillment.
+     *
+     * The status field accepts two types of values:
+     *
+     * **Statuses** (e.g., `in_transit`, `delivered`): Real carrier tracking statuses that update the shipment's current status. When you send these, the fulfillment's current status is updated to reflect the new state. Triggers any configured automations for that status.
+     *
+     * **Events** (e.g., `stalled_in_transit`, `delayed`, `arriving_early`): Special event types that trigger automations without changing the current shipment status. The status field remains unchanged, but you can still update estimated delivery date and add tracking history entries. Use these to trigger event-based automations.
+     *
+     * Both statuses and events can update other fields like estimated delivery date and tracking history.
+     */
+    post: operations["Fulfillment status update"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+        fulfillmentId: components["parameters"]["fulfillment-id.param"];
+      };
+    };
+  };
   "/stores/{storeId}/products/bulk-upload": {
     /**
      * Bulk upload products (Beta)
@@ -1136,6 +1201,253 @@ export interface components {
        */
       total: components["schemas"]["money.schema"];
     };
+    /** @description Request body for creating a fulfillment. */
+    "orders-api-create-fulfillment-request.schema": {
+      /** @description Unique identifier for the fulfillment. If not provided, will be auto-generated. */
+      fulfillmentId?: string;
+      /** @description Initial tracking information for the dummy tracker. Only used when useDummyTracking is true. If not specified, defaults to status "pre_transit". */
+      initialTracking?: {
+        /**
+         * Format: date-time
+         * @description Timestamp of the tracking event in ISO 8601 format.
+         */
+        datetime?: string | null;
+        /**
+         * Format: date-time
+         * @description Estimated delivery date in ISO 8601 format.
+         */
+        estimatedDeliveryDate?: string | null;
+        location?: components["schemas"]["orders-api-tracking-location.schema"];
+        /** @description Tracking event message. */
+        message?: string | null;
+        /**
+         * @description Initial shipment status for the dummy tracker. Only actual statuses are allowed (not automation events).
+         * @enum {string}
+         */
+        status: "pre_transit" | "unknown" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "delivered" | "return_to_sender" | "failure" | "cancelled" | "error";
+      };
+      /** @description List of line items to fulfill. */
+      lineItems: {
+          /** @description Line item ID to fulfill. */
+          id: string;
+          /** @description Quantity to fulfill for this line item. */
+          quantity: number;
+        }[];
+      /** @description Optional tracking information for the shipment. */
+      tracking?: {
+        /** @description Name of the shipping carrier (e.g., FedEx, UPS, USPS). */
+        carrier: string;
+        /** @description Tracking number/code for the shipment. */
+        code: string;
+      } | null;
+      /** @description If true, creates a dummy tracker for testing without calling external tracking APIs. Useful for development and testing the fulfillment status update endpoint. */
+      useDummyTracking?: boolean;
+    };
+    /** @description Request body for creating an order. */
+    "orders-api-create-order-request.schema": {
+      /**
+       * Format: date-time
+       * @description ISO 8601 date string for when the order was created.
+       */
+      createdAt: string;
+      /** @description Currency code from the ISO 4217 standard (e.g., USD, EUR, GBP). */
+      currencyCode?: string | null;
+      customer?: components["schemas"]["orders-api-customer.schema"];
+      /** @description List of line items in the order. */
+      lineItems: components["schemas"]["orders-api-line-item.schema"][];
+      /** @description Unique identifier for the order. */
+      orderId: string;
+      shipping?: components["schemas"]["orders-api-shipping.schema"];
+      /** @description Subtotal price excluding tax and shipping. */
+      subtotalPrice?: number | null;
+      /** @description Optional tags associated with the order. */
+      tags?: string[] | null;
+      /** @description Total order price including tax and shipping. */
+      totalPrice?: number | null;
+      /** @description Total tax amount. */
+      totalTax?: number | null;
+    };
+    /** @description Successful order creation response. */
+    "orders-api-create-order-response.schema": {
+      /** @description Original external order ID provided in the request. */
+      externalOrderId: string;
+      /** @description Internal Redo order ID. */
+      orderId: string;
+    };
+    /** @description Customer information. */
+    "orders-api-customer.schema": {
+      /** @description Customer email address. */
+      email?: string | null;
+      /** @description Customer first name. */
+      firstName?: string | null;
+      /** @description Customer ID from the external system. */
+      id?: string | null;
+      /** @description Customer last name. */
+      lastName?: string | null;
+      /** @description Customer full name. */
+      name?: string | null;
+      /** @description Customer phone number. */
+      phoneNumber?: string | null;
+    };
+    /** @description Successful order deletion response. */
+    "orders-api-delete-order-response.schema": {
+      /** @description External order ID that was deleted. */
+      externalOrderId: string;
+      /** @description Internal Redo order ID. */
+      orderId: string;
+      /** @description Indicates successful deletion. */
+      success: boolean;
+    };
+    /** @description Orders API error response. */
+    "orders-api-error.schema": {
+      /** @description Error message describing what went wrong. */
+      error: string;
+    };
+    /** @description Fulfilled line item details. */
+    "orders-api-fulfillment-line-item.schema": {
+      /** @description Line item ID that was fulfilled. */
+      id: string;
+      /** @description Product ID. */
+      productId: string;
+      /** @description Quantity fulfilled for this line item. */
+      quantity: number;
+      /** @description SKU of the product. */
+      sku?: string | null;
+      /** @description Title/name of the product. */
+      title: string;
+      /** @description Product variant ID. */
+      variantId?: string | null;
+    };
+    /** @description Successful fulfillment operation response. */
+    "orders-api-fulfillment-response.schema": {
+      fulfillment: components["schemas"]["orders-api-fulfillment.schema"];
+      /** @constant */
+      success: true;
+    };
+    /** @description Fulfillment information. */
+    "orders-api-fulfillment.schema": {
+      /**
+       * Format: date-time
+       * @description ISO 8601 date string for when the fulfillment was created.
+       */
+      createdAt: string;
+      /** @description Unique fulfillment ID. */
+      id: string;
+      /** @description List of line items in this fulfillment. */
+      lineItems: components["schemas"]["orders-api-fulfillment-line-item.schema"][];
+      /**
+       * @description Current shipment status.
+       * @enum {string}
+       */
+      status: "pre_transit" | "unknown" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "delivered" | "return_to_sender" | "failure" | "cancelled" | "error";
+      /** @description Shipping carrier name (e.g., FedEx, UPS). */
+      trackingCompany?: string | null;
+      /** @description List of tracking events in chronological order. */
+      trackingHistory: components["schemas"]["orders-api-tracking-event.schema"][];
+      /** @description Tracking number for the shipment. */
+      trackingNumber?: string | null;
+    };
+    /** @description Response for getting an order, including fulfillments. */
+    "orders-api-get-order-response.schema": components["schemas"]["orders-api-create-order-request.schema"] & {
+      /** @description List of fulfillments for this order. */
+      fulfillments: components["schemas"]["orders-api-fulfillment.schema"][];
+    };
+    /** @description Line item in the order. */
+    "orders-api-line-item.schema": {
+      /** @description Unique identifier for the line item. */
+      id: string;
+      /** @description Price per unit of the product. */
+      price?: number | null;
+      /** @description Identifier for the product. */
+      productId: string;
+      /** @description Quantity of the product ordered. */
+      quantity: number;
+      /** @description SKU of the product. */
+      sku?: string | null;
+      /** @description Title/name of the product. */
+      title: string;
+      /** @description Identifier for the product variant. */
+      variantId?: string | null;
+    };
+    /** @description Shipping address. */
+    "orders-api-shipping-address.schema": {
+      /** @description Primary address line. */
+      address1?: string | null;
+      /** @description Secondary address line. */
+      address2?: string | null;
+      /** @description City. */
+      city?: string | null;
+      /** @description Country. */
+      country?: string | null;
+      /** @description Postal or zip code. */
+      postalCode?: string | null;
+      /** @description State or province. */
+      province?: string | null;
+    };
+    /** @description Shipping information. */
+    "orders-api-shipping.schema": {
+      address?: components["schemas"]["orders-api-shipping-address.schema"];
+      /** @description Shipping cost. */
+      cost?: number | null;
+      /** @description Shipping method name. */
+      method?: string | null;
+    };
+    /** @description Tracking event details. */
+    "orders-api-tracking-event.schema": {
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp of the tracking event.
+       */
+      datetime: string;
+      location?: components["schemas"]["orders-api-tracking-location.schema"];
+      /** @description Tracking event message. */
+      message: string;
+      /** @description Status at this tracking event. */
+      status: string;
+    };
+    /** @description Location information for a tracking event. */
+    "orders-api-tracking-location.schema": {
+      city?: string | null;
+      country?: string | null;
+      postalCode?: string | null;
+      state?: string | null;
+    };
+    /**
+     * @description Request body for updating a fulfillment's tracking status.
+     *
+     * The status field accepts two types of values:
+     * - **Statuses** (e.g., `in_transit`, `delivered`): Update the shipment's current status and trigger configured automations.
+     * - **Events** (e.g., `stalled_in_transit`, `delayed`, `arriving_early`): Trigger automations without changing the current shipment status.
+     *
+     * Both can update other fields like estimated delivery date and tracking history.
+     */
+    "orders-api-update-fulfillment-status-request.schema": {
+      /**
+       * Format: date-time
+       * @description Timestamp of the tracking event in ISO 8601 format.
+       */
+      datetime?: string | null;
+      /**
+       * Format: date-time
+       * @description Estimated delivery date in ISO 8601 format.
+       */
+      estimatedDeliveryDate?: string | null;
+      location?: components["schemas"]["orders-api-tracking-location.schema"];
+      /** @description Tracking event message (e.g., "Departed shipping partner facility"). */
+      message?: string | null;
+      /**
+       * @description Shipment status or automation event.
+       *
+       * Statuses update the current shipment status and trigger automations:
+       * `pre_transit`, `in_transit`, `out_for_delivery`, `available_for_pickup`, `delivered`, `return_to_sender`, `failure`, `cancelled`, `error`.
+       *
+       * Events trigger automations without changing the current status:
+       * `stalled_in_transit`, `delayed`, `arriving_early`.
+       *
+       * @enum {string}
+       */
+      status: "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "delivered" | "return_to_sender" | "failure" | "cancelled" | "error" | "stalled_in_transit" | "delayed" | "arriving_early";
+    };
     /**
      * Person name
      * @description Person name.
@@ -1178,6 +1490,32 @@ export interface components {
        */
       name: string;
     };
+    /**
+     * Return Dropoff
+     * @description Dropoff entry for returns using QR-code-based drop-off methods (e.g. BlueYonder/FedEx Easy Returns)
+     */
+    "return-dropoff.schema": {
+      /**
+       * Provider
+       * @description Dropoff provider name (e.g. "FedEx Easy Returns", "Virtual")
+       */
+      provider: string;
+      /**
+       * QR Code
+       * @description Raw QR code data
+       */
+      qrCode?: string;
+      /**
+       * QR Code URL
+       * @description URL to a rendered QR code image
+       */
+      qrCodeUrl?: string;
+      /**
+       * Shipment Group ID
+       * @description ID of the shipment group this dropoff belongs to
+       */
+      shipmentGroupId: string;
+    };
     /**
      * Return
      * @description Return read.
@@ -1211,6 +1549,11 @@ export interface components {
          */
         phoneNumber?: components["schemas"]["phone-number.schema"];
       };
+      /**
+       * Dropoffs
+       * @description Array of QR-code-based dropoff entries for returns using drop-off methods such as BlueYonder/FedEx Easy Returns. Empty for standard label-based returns.
+       */
+      dropoffs?: components["schemas"]["return-dropoff.schema"][];
       /**
        * Exchange
        * @description Exchange order
@@ -1924,10 +2267,14 @@ export interface components {
   };
   responses: never;
   parameters: {
+    /** @description Unique fulfillment identifier. */
+    "fulfillment-id.param": string;
     /** @description Optional idempotency key for safely retrying create requests. */
     "idempotency-key.param"?: string;
     /** @description Invoice ID */
     "invoice-id.param": string;
+    /** @description Order ID. Can be either the external order ID provided when creating the order, or the internal Redo order ID. */
+    "order-id.param": string;
     /**
      * @description Page marker, from X-Page-Next header
      * @example 64df700931a04885276c3364
@@ -2652,6 +2999,237 @@ export interface operations {
       };
     };
   };
+  /**
+   * Create Order
+   * @description Create a new order in the system with line items, customer information, and shipping details.
+   */
+  "Order create": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["orders-api-create-order-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["orders-api-create-order-response.schema"];
+        };
+      };
+      /** @description Bad Request (validation error) */
+      400: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Unauthorized (invalid or missing API token) */
+      401: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Conflict (duplicate order ID) */
+      409: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Get Order
+   * @description Retrieve an existing order from the system, including all fulfillments. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+   */
+  "Order get": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["orders-api-get-order-response.schema"];
+        };
+      };
+      /** @description Unauthorized (invalid or missing API token) */
+      401: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Order not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Delete Order
+   * @description Delete an order from the system. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+   */
+  "Order delete": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["orders-api-delete-order-response.schema"];
+        };
+      };
+      /** @description Unauthorized (invalid or missing API token) */
+      401: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Order not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Create Fulfillment
+   * @description Create a fulfillment for specific line items within an order, including tracking information. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response.
+   */
+  "Fulfillment create": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["orders-api-create-fulfillment-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["orders-api-fulfillment-response.schema"];
+        };
+      };
+      /** @description Bad Request (validation error) */
+      400: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Unauthorized (invalid or missing API token) */
+      401: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Order not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Update Fulfillment Status
+   * @description Post a shipment status update or trigger an automation event for a fulfillment.
+   *
+   * The status field accepts two types of values:
+   *
+   * **Statuses** (e.g., `in_transit`, `delivered`): Real carrier tracking statuses that update the shipment's current status. When you send these, the fulfillment's current status is updated to reflect the new state. Triggers any configured automations for that status.
+   *
+   * **Events** (e.g., `stalled_in_transit`, `delayed`, `arriving_early`): Special event types that trigger automations without changing the current shipment status. The status field remains unchanged, but you can still update estimated delivery date and add tracking history entries. Use these to trigger event-based automations.
+   *
+   * Both statuses and events can update other fields like estimated delivery date and tracking history.
+   */
+  "Fulfillment status update": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        orderId: components["parameters"]["order-id.param"];
+        fulfillmentId: components["parameters"]["fulfillment-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["orders-api-update-fulfillment-status-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["orders-api-fulfillment-response.schema"];
+        };
+      };
+      /** @description Bad Request (validation error) */
+      400: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Unauthorized (invalid or missing API token) */
+      401: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Fulfillment not found */
+      404: {
+        content: {
+          "application/json": components["schemas"]["orders-api-error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Bulk upload products (Beta)
    * @description Bulk create or update product families and their variants.