Skip to content

OrderReturn

Type: schema

TypeScript Definition

typescript
OrderReturn: {{
            request_number?: string;
            /** @enum {string} */
            status?: "created" | "approved" | "rejected" | "complete" | "cancelled";
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
            /** Format: date-time */
            approved_at?: string;
            /** Format: date-time */
            rejected_at?: string;
            items?: components["schemas"]["OrderReturnItem"][];
            /** Format: date-time */
            received_at?: string;
        };
        /** OrderReturnDetail */
}

Component References

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

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",
      "enum": [
        "created",
        "approved",
        "rejected",
        "complete",
        "cancelled"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "approved_at": {
      "type": "string",
      "format": "date-time"
    },
    "rejected_at": {
      "type": "string",
      "format": "date-time"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderReturnItem"
      }
    },
    "received_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: