upload-order-return-attachments

Method: POST
Path: /orders/{order_number}/returns/{return_number}/attachments

Tags: Orders

Summary

Upload order return attachments

Description

Uploads supporting images and videos for a return request. Use to provide evidence such as product condition or damage.

Storefront SDK Usage

SDK Method: sdk.order.uploadOrderReturnAttachments()

Example:

const imageFiles = Array.from(document.getElementById('image-input').files);

const { data, error } = await sdk.order.uploadOrderReturnAttachments(
  { order_number: "ORD-2024-001", return_number: "RET-2024-001" },
  {
    images: imageFiles,
    videos: [new File(["video data"], "damage.mp4", { type: "video/mp4" })]
  }
);

if (error) {
  console.error("Failed to upload attachments:", error.message);
} else {
  console.log("Attachments uploaded:", data.success);
  console.log("Message:", data.message);
}

TypeScript Definition

"upload-order-return-attachments": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description The unique identifier of the Order. */
                order_number: string;
                /** @description The unique identifier of the return request. */
                return_number: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "multipart/form-data": components["schemas"]["UploadOrderReturnAttachments"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["UploadOrderReturnAttachments"]	UploadOrderReturnAttachments
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• order_number (path): The unique identifier of the Order.
• return_number (path): The unique identifier of the return request.

Request Body

Content Types: multipart/form-data

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Orders"
  ],
  "operationId": "upload-order-return-attachments",
  "summary": "Upload order return attachments",
  "description": "Uploads supporting images and videos for a return request. Use to provide evidence such as product condition or damage.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/upload-order-return-attachments",
    "description": "API reference for the upload-order-return-attachments operation"
  },
  "parameters": [
    {
      "name": "order_number",
      "in": "path",
      "description": "The unique identifier of the Order.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "return_number",
      "in": "path",
      "description": "The unique identifier of the return request.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/UploadOrderReturnAttachments"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "orders",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "uploadOrderReturnAttachments"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions