Skip to content

OrderReturnDetail

Type: schema

TypeScript Definition

typescript
OrderReturnDetail: {components["schemas"]["OrderReturn"] & {
            return_order?: components["schemas"]["OrderReturnOrder"] | null
}

Component References

ReferenceResolves To
components["schemas"]["OrderReturn"]OrderReturn
components["schemas"]["OrderReturnOrder"]OrderReturnOrder

OpenAPI Schema

json
{
  "title": "OrderReturnDetail",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderReturnDetail",
    "description": "API reference for the OrderReturnDetail schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/OrderReturn"
    },
    {
      "type": "object",
      "properties": {
        "return_order": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/OrderReturnOrder"
            },
            {
              "type": "null"
            }
          ]
        },
        "replacement_order": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/OrderReturnReplacementOrder"
            },
            {
              "type": "null"
            }
          ]
        },
        "refund": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/OrderRefund"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "attachments": {
          "description": "Signed URLs for supporting images and videos uploaded with the return request.",
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "images": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "videos": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              },
              "required": [
                "images",
                "videos"
              ]
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: