--- title: Add Client Order State slug: api-documentation/add-client-order-state docTags: createdAt: 2026-08-27T16:57:40.129Z --- { "id": "9VUGuEL6ls-ciafF0YX0m", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/order/client-state", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/client-state" } ], "name": "Add Client Order State", "description": "

This endpoint allows administrators to add a new client order state. It includes details such as the client state ID, name, internal state, transition action, and audit information.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The request body must include all necessary details for the new client order state.", "customType": "AddClientOrderStateRequest", "schema": [ { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "name", "kind": "required", "type": "string", "description": "The name of the client state" }, { "name": "color", "kind": "required", "type": "string", "description": "The color of the client state to be shown on the Portal" }, { "name": "internalState", "kind": "required", "type": "string", "description": "The internal state associated with the client state" }, { "name": "description", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/AddClientOrderStateRequest", "isExpanded": true } ], "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" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "

Success-New client order state created.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "AddClientOrderStateResponse", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The ID of the newly created client order state" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "name", "kind": "required", "type": "string", "description": "The name of the client state" }, { "name": "internalState", "kind": "required", "type": "string", "description": "The internal state associated with the client state" }, { "name": "color", "kind": "required", "type": "string", "description": "The color of the client state to be shown on the Portal" }, { "name": "description", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/AddClientOrderStateResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "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": "403", "description": "The provided credentials were not valid for this endpoint. It may be 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": "500", "description": "Internal server error.", "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": "WRNHAGO9ynXv-eLTqT_pd", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/order/client-state \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"siteIds\": [],\n \"name\": \"\",\n \"color\": \"\",\n \"internalState\": \"\"\n }'" }, { "id": "_CxgdMUbP2_wcTFqy0IUz", "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 raw = JSON.stringify({\n \"siteIds\": [],\n \"name\": \"\",\n \"color\": \"\",\n \"internalState\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/client-state\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "dlzeCz9zydrm9cXeoBHfY", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/client-state\")\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\"\nrequest.body = JSON.dump({\n \"siteIds\": [],\n \"name\": \"\",\n \"color\": \"\",\n \"internalState\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "VvDjL8HK89SDHVSnVx8aw", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/client-state\"\n\npayload = json.dumps({\n \"siteIds\": [],\n \"name\": \"\",\n \"color\": \"\",\n \"internalState\": \"\"\n})\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": "WRNHAGO9ynXv-eLTqT_pd" }, "results": { "languages": [ { "id": "C1rCsuOZU73pxo9FZMLpx", "language": "201", "code": "// Success-New client order state created.\n{\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"name\": \"\",\n \"internalState\": \"\",\n \"color\": \"\",\n \"description\": \"\"\n}" }, { "id": "9h2y8QGMbIw10eyYkR1it", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "aISUVYhJQgbMN8R7tVY2r", "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": "XDO_dSU1oXsr-2ZZvhHWo", "language": "403", "code": "// The provided credentials were not valid for this endpoint. It may be that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "9wfSfCWj3Akd0OtM3CjGc", "language": "500", "code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "C1rCsuOZU73pxo9FZMLpx" } }, "children": [ { "text": "" } ] }