Skip to content

OrderRefund

Type: schema

Description

Order refund model

TypeScript Definition

typescript
OrderRefund: {{
            request_number?: string;
            /** Format: double */
            refund_amount?: number;
            /** Format: date-time */
            refund_date?: string;
            /** @enum {string} */
            status?: "pending" | "approved" | "success" | "failed";
            /** @enum {string} */
            payment_mode?: "PaymentGateway" | "ClubAI" | "BankTransfer";
            payment_method?: string;
            payment_reference_number?: string;
            bank_account_number?: string;
            bank_name?: string;
            refund_remarks?: string;
        };
        /** OrderReturn */
}

OpenAPI Schema

json
{
  "title": "OrderRefund",
  "description": "Order refund model",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderRefund",
    "description": "API reference for the OrderRefund schema"
  },
  "properties": {
    "request_number": {
      "type": "string"
    },
    "refund_amount": {
      "type": "number",
      "format": "double"
    },
    "refund_date": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "approved",
        "success",
        "failed"
      ]
    },
    "payment_mode": {
      "type": "string",
      "enum": [
        "PaymentGateway",
        "ClubAI",
        "BankTransfer"
      ]
    },
    "payment_method": {
      "type": "string"
    },
    "payment_reference_number": {
      "type": "string"
    },
    "bank_account_number": {
      "type": "string"
    },
    "bank_name": {
      "type": "string"
    },
    "refund_remarks": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: