create-order-return

Method: POST
Path: /orders/{order_number}/return

Tags: Orders

Summary

Create order return

Description

Create order return

TypeScript Definition

"create-order-return": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description order number */
                order_number: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["CreateOrderReturn"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @default order details */
                        readonly message: string;
                        readonly success?: boolean;
                        content?: {
                            order_return?: components["schemas"]["OrderReturn"];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["CreateOrderReturn"]	CreateOrderReturn
components["schemas"]["OrderReturn"]	OrderReturn
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• order_number (path): order number

Request Body

Content Types: application/json

Responses

200

OK

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Orders"
  ],
  "operationId": "create-order-return",
  "summary": "Create order return",
  "description": "Create order return",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/create-order-return",
    "description": "API reference for the create-order-return operation"
  },
  "parameters": [
    {
      "name": "order_number",
      "in": "path",
      "description": "order number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateOrderReturn"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "default": "order details",
                "readOnly": true
              },
              "success": {
                "type": "boolean",
                "readOnly": true
              },
              "content": {
                "properties": {
                  "order_return": {
                    "$ref": "#/components/schemas/OrderReturn"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "orders",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "createOrderReturn"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions