CreateOrderReturn

Type: schema

TypeScript Definition

CreateOrderReturn: {{
            /**
             * @description How the customer wants the return resolved.
             * @enum {string}
             */
            requested_settlement: "refund" | "replacement";
            /** @description Delivered line items to include in the return request. */
            items: components["schemas"]["OrderReturnItem"][];
        };
        /** CreateOutboundBankAccount */
}

Component References

Reference	Resolves To
components["schemas"]["OrderReturnItem"]	OrderReturnItem

OpenAPI Schema

{
  "title": "CreateOrderReturn",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreateOrderReturn",
    "description": "API reference for the CreateOrderReturn schema"
  },
  "required": [
    "requested_settlement",
    "items"
  ],
  "properties": {
    "requested_settlement": {
      "description": "How the customer wants the return resolved.",
      "type": "string",
      "enum": [
        "refund",
        "replacement"
      ]
    },
    "items": {
      "description": "Delivered line items to include in the return request.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderReturnItem"
      },
      "minItems": 1
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions