Skip to content

OrderReturnItem

Type: schema

TypeScript Definition

typescript
OrderReturnItem: {{
            shipment_number: string;
            product_id: string;
            product_name?: $Read<string>;
            product_image_url?: $Read<string | null>;
            variant_id: string | null;
            variant_name?: $Read<string | null>;
            quantity: number;
            return_reason?: string;
        };
        /** OrderReturnOrder */
}

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": [
    "shipment_number",
    "product_id",
    "variant_id",
    "quantity",
    "reason"
  ],
  "properties": {
    "shipment_number": {
      "type": "string"
    },
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "product_image_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "return_reason": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: