(DEPRECATED) 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": "200", "description": "Data Execution Successful.", "jsonExample": "", "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.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ValidationErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "403", "description": "User's roles are insufficient for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "405", "description": "This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "406", "description": "This is to indicate that the resource requested by the client cannot be provided in a format that is acceptable according to the Accept headers sent in the request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "409", "description": "This is to indicate a conflict between the current state of a resource and the request made by the client. It indicates that the server cannot complete the request due to a conflict with the current state of the resource.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "412", "description": "This is to indicate that a client request is not processed because one or more preconditions given in the request header fields failed to be met.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "415", "description": "This is to indicate that the server cannot process the request because the media type of the request entity is not supported or not recognized by the server.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "default", "description": "This is the default internal server error. System was not able to process this request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "LNromcNsLM7vyDcYmFZ0F", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/pim/rafc/upsert-rafc \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string'" }, { "id": "oWWVm1GEhFLn6WjlcAQlU", "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\");\nmyHeaders.append(\"x-upstart-site\", \"string\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/pim/rafc/upsert-rafc\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "1iouLjYNgIWvwer02ePZx", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/pim/rafc/upsert-rafc\")\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[\"x-upstart-site\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "1UnBSmxxojeDjJ9MDr1fX", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/pim/rafc/upsert-rafc\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "LNromcNsLM7vyDcYmFZ0F" }, "results": { "languages": [ { "id": "Iu2fw1XAck7MmZlgav-_6", "language": "200", "code": "// Data Execution Successful.\n" }, { "id": "kRots58QaYkzS8SoNGdez", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{}" }, { "id": "sQtA-cwx4nNgrag_s2d0I", "language": "401", "code": "// The provided credentials were not valid for this endpoint.\n{}" }, { "id": "oHDtXOA35YDVNsTYBWwxR", "language": "403", "code": "// User's roles are insufficient for this endpoint.\n{}" }, { "id": "HfRa9m6DHt3oCmDXAEvgy", "language": "405", "code": "// This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.\n{}" }, { "id": "zTRU-RwmzD3WPG_vNu5Rm", "language": "406", "code": "// This is to indicate that the resource requested by the client cannot be provided in a format that is acceptable according to the Accept headers sent in the request.\n{}" }, { "id": "CqumS_D0W5OhNJ8-vEcSp", "language": "409", "code": "// This is to indicate a conflict between the current state of a resource and the request made by the client. It indicates that the server cannot complete the request due to a conflict with the current state of the resource.\n{}" }, { "id": "o0mnaEpFKh2r-prHM_CSD", "language": "412", "code": "// This is to indicate that a client request is not processed because one or more preconditions given in the request header fields failed to be met.\n{}" }, { "id": "dIdu4LlUUC2xBUYnPZ2tb", "language": "415", "code": "// This is to indicate that the server cannot process the request because the media type of the request entity is not supported or not recognized by the server.\n{}" }, { "id": "eA75UNbLy7a9KEIjNgs-t", "language": "default", "code": "// This is the default internal server error. System was not able to process this request.\n{}" } ], "selectedLanguageId": "Iu2fw1XAck7MmZlgav-_6" } }, "children": [ { "text": "" } ] }