Skip to content

OrderReturn

Type: schema

TypeScript Definition

typescript
OrderReturn: {{
            request_number?: string;
            status?: string;
            return_items?: components["schemas"]["OrderReturnItem"][];
            /** Format: double */
            subtotal?: number;
            /** Format: double */
            shipping_amount?: number;
            /** Format: double */
            total_tax?: number;
            /** Format: double */
            grand_total?: number;
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            approved_at?: string;
            /** Format: date-time */
            shipped_at?: string;
            /** Format: date-time */
            received_at?: string;
            original_order_number?: string;
            /** Format: date-time */
            original_order_delivered_at?: string;
            replacement_order_number?: string;
            /** Format: date-time */
            replacement_order_date?: string;
            /** Format: double */
            replacement_order_amount?: number;
            refund?: components["schemas"]["OrderRefund"][];
        };
        /** OrderReturnItem */
}

Component References

ReferenceResolves To
components["schemas"]["OrderReturnItem"]OrderReturnItem
components["schemas"]["OrderRefund"]OrderRefund

OpenAPI Schema

json
{
  "title": "OrderReturn",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderReturn",
    "description": "API reference for the OrderReturn schema"
  },
  "properties": {
    "request_number": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "return_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderReturnItem"
      }
    },
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "total_tax": {
      "type": "number",
      "format": "double"
    },
    "grand_total": {
      "type": "number",
      "format": "double"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "approved_at": {
      "type": "string",
      "format": "date-time"
    },
    "shipped_at": {
      "type": "string",
      "format": "date-time"
    },
    "received_at": {
      "type": "string",
      "format": "date-time"
    },
    "original_order_number": {
      "type": "string"
    },
    "original_order_delivered_at": {
      "type": "string",
      "format": "date-time"
    },
    "replacement_order_number": {
      "type": "string"
    },
    "replacement_order_date": {
      "type": "string",
      "format": "date-time"
    },
    "replacement_order_amount": {
      "type": "number",
      "format": "double"
    },
    "refund": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderRefund"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: