Skip to content

OrderReturnItem

Type: schema

TypeScript Definition

typescript
OrderReturnItem: {{
            product_id: string;
            product_name?: $Read<string>;
            product_image_url?: $Read<string>;
            sku: string;
            /** Format: double */
            selling_price?: $Read<number>;
            /** @constant */
            tax_type?: $Read<"GST">;
            tax_rate?: $Read<number>;
            quantity: number;
            /** @enum {string} */
            resolution: "refund" | "replacement";
            return_reason: string;
        };
        /**
         * OrderShipment
         * @description Order shipment model
         */
}

OpenAPI Schema

json
{
  "title": "OrderReturnItem",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderReturnItem",
    "description": "API reference for the OrderReturnItem schema"
  },
  "required": [
    "product_id",
    "sku",
    "quantity",
    "resolution",
    "return_reason"
  ],
  "properties": {
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "product_image_url": {
      "type": "string",
      "readOnly": true
    },
    "sku": {
      "type": "string"
    },
    "selling_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "tax_type": {
      "type": "string",
      "const": "GST",
      "readOnly": true
    },
    "tax_rate": {
      "type": "number",
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "resolution": {
      "type": "string",
      "enum": [
        "refund",
        "replacement"
      ]
    },
    "return_reason": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: