--- title: Force Close Single Order slug: api-documentation/force-close-single-order docTags: createdAt: 2026-08-27T16:57:40.129Z --- { "id": "nvV2CIahohTMnJh_5Lnip", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/order/{orderId}/forceClose", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/{orderId}/forceClose" } ], "name": "Force Close Single Order", "description": "

This endpoint allows administrators to force close an order.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "orderId", "type": "string", "description": "The parameterized order id in the URI.", "format": "uuid" } ], "headerParameters": [ { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" }, { "id": "ApiKeyAccess", "name": "X-Upstart-Api-Key", "kind": "optional", "type": "apiKey", "description": "Api key based authorization.", "in": "header" }, { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "

Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "202", "description": "

Success-order marked for closing.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Pnwqt7OBymv93L4ywZde2", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/order/{orderId}/forceClose \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "zq7fQ7RPQfX0SmouODR4G", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/{orderId}/forceClose\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "W90LkZg05w9lk9jAQcOAT", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/{orderId}/forceClose\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "mPhN3wB8b31-rsX3xmJbk", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/{orderId}/forceClose\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Pnwqt7OBymv93L4ywZde2" }, "results": { "languages": [ { "id": "5-THtm54vp6z7sL0MI-zf", "language": "202", "code": "// Success-order marked for closing.\n" }, { "id": "MiGhT9OdGOBJ8AZ5u6qgE", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "m3OKMLknGNKCgBFK9XDA5", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "5-THtm54vp6z7sL0MI-zf" } }, "children": [ { "text": "" } ] }