cancel-order-return

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

Tags: Orders

Summary

Cancel order return

Description

Cancels an existing return request. Use when the return should no longer be processed. Returns the updated OrderReturn object.

Storefront SDK Usage

SDK Method: sdk.order.cancelOrderReturn()

Example:

const { data, error } = await sdk.order.cancelOrderReturn(
  { order_number: "ORD-2024-001", return_number: "RET-2024-001" },
  { reason: "Decided to keep the product" }
);

if (error) {
  console.error("Failed to cancel return:", error.message);
} else {
  console.log("Return cancelled");
  console.log("Updated status:", data.order_return?.status);
}

TypeScript Definition

"cancel-order-return": {
        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: {
                "application/json": {
                    reason: string;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            order_return?: components["schemas"]["OrderReturn"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["OrderReturn"]	OrderReturn
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: application/json

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": "cancel-order-return",
  "summary": "Cancel order return",
  "description": "Cancels an existing return request. Use when the return should no longer be processed. Returns the updated `OrderReturn` object.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/cancel-order-return",
    "description": "API reference for the cancel-order-return 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": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "reason"
          ],
          "properties": {
            "reason": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "order_return": {
                    "$ref": "#/components/schemas/OrderReturn"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "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": "cancelOrderReturn"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions