Enable the shareable status of a wishlist for a consumer, granting control over the accessibility of their wishlist.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "wishListId", "type": "string", "description": "WishList Id to fetch the full wishlist." } ], "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." }, { "kind": "required", "name": "x-upstart-site", "type": "string", "description": "The site identifier." }, { "kind": "required", "name": "consumerId", "type": "string", "description": "Consumer Id to fetch the wishlists." }, { "kind": "optional", "name": "If-Match", "type": "string", "description": "The ETag of the resource to update. If the conditional does not match then the 412 (Precondition Failed) response is returned.
" }, { "kind": "required", "name": "if-unmodified-since", "type": "stringIn the case of modifying a resource, this header is sent in the request to indicate when the resource was last pulled-support optimistic locking.\nSee also the \"lastModified\" value in the associated resource. This value should be pulled from last state of the resource and set as the value of this request.
", "format": "date-time" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "WishListShareableRequest", "schema": [ { "name": "shareable", "kind": "required", "type": "boolean", "description": "", "default": false } ], "modelRef": "#/components/schemas/WishListShareableRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "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" }, { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "ETag", "description": "" }, { "kind": "optional", "name": "Location", "description": "" } ], "schema": [ { "kind": "optional", "type": "object", "description": "Response Model of wishlist", "customType": "WishListResponse", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/WishListId", "customType": "WishListId", "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "shareable", "kind": "required", "type": "boolean", "description": "", "default": false }, { "name": "items", "kind": "required", "type": "array", "description": "Model of each wishlist item", "modelRef": "#/components/schemas/WishListItem", "customType": "WishListItem[]", "schema": [ { "name": "skuId", "kind": "required", "type": "string", "description": "Sku id of the item in the wishlist" }, { "name": "itemId", "kind": "required", "type": "string", "description": "catalog item id of the item in the wishlist" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "imageUri", "kind": "optional", "type": "string", "description": "" }, { "name": "inStock", "kind": "optional", "type": "boolean", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "", "default": 1 }, { "name": "notes", "kind": "optional", "type": "string", "description": "", "maxLength": 300 } ] }, { "name": "link", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModified", "kind": "optional", "type": "stringThis is to indicate that the precondition of etag or if-modified-since has failed.
", "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": "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", "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": "422", "description": "This is to indicate that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
", "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": "There was an 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": "3yjHQkUJ53jT-C9QagFyD", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/wishlist/{wishListId}/set-status \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string' \\\n --header 'consumerid: string' \\\n --header 'if-unmodified-since: 2017-07-21T17:32:28Z' \\\n --data '{\n \"shareable\": false\n }'" }, { "id": "KO1VwUyYFFoYauvbw5Cfa", "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\");\nmyHeaders.append(\"consumerid\", \"string\");\nmyHeaders.append(\"if-unmodified-since\", \"2017-07-21T17:32:28Z\");\n\nvar raw = JSON.stringify({\n \"shareable\": false\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/wishlist/{wishListId}/set-status\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "9B5O4O75Mv6xfPZuMHSTH", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/wishlist/{wishListId}/set-status\")\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\"\nrequest[\"consumerid\"] = \"string\"\nrequest[\"if-unmodified-since\"] = \"2017-07-21T17:32:28Z\"\nrequest.body = JSON.dump({\n \"shareable\": false\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "huP7lWRV1v6UJqlqKUX-H", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/wishlist/{wishListId}/set-status\"\n\npayload = json.dumps({\n \"shareable\": False\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string',\n 'consumerid': 'string',\n 'if-unmodified-since': '2017-07-21T17:32:28Z'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "3yjHQkUJ53jT-C9QagFyD" }, "results": { "languages": [ { "id": "ae71GUbo4hHCz1rC6dsZf", "language": "200", "code": "// OK\n{\n \"id\": \"\",\n \"name\": \"\",\n \"shareable\": false,\n \"items\": [\n {\n \"skuId\": \"\",\n \"itemId\": \"\",\n \"name\": \"\",\n \"imageUri\": \"\",\n \"inStock\": false,\n \"quantity\": 0,\n \"notes\": \"\"\n }\n ],\n \"link\": \"\",\n \"lastModified\": \"2017-07-21T17:32:28Z\"\n}" }, { "id": "4Bo6JhmOBh_u9ltawo7Ei", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\",\n \"metadata\": \"\"\n }\n]" }, { "id": "ePAH7gxy5KKOuOnl9zIUc", "language": "401", "code": "// The provided credentials were not valid for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "43bgrnF9BG8CpOWC-zjv4", "language": "403", "code": "// User's roles are insufficient for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "zVm4sPaDnKBLIOXW7VCq6", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "6ox7kzCkAwqhRS2LNBZm4", "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{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "BL6BJ7breAWVpPAcmwiPE", "language": "412", "code": "// This is to indicate that the precondition of etag or if-modified-since has failed.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "QlQGqXKdccIEr8sKL5bxk", "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{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "Oh91kvqFFdBiiv6rf9t8R", "language": "422", "code": "// This is to indicate that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "WTcKbnYMZTVTyVXGxbDmE", "language": "500", "code": "// There was an internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "ae71GUbo4hHCz1rC6dsZf" } }, "children": [ { "text": "" } ] }