{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":481,"path":"api-reference/rest-apis/c_ServiceCatalogAPI.md","title":"Service Catalog API","bundle":null,"doc_type":null,"release":"australia","body":"\n# Service Catalog API\n\nThe Service Catalog API provides endpoints that access Service Catalog configuration and actions from within a Service Portal.\n\n**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md)\n\n## Service Catalog - DELETE /sn\\_sc/servicecatalog/cart/\\{cart\\_item\\_id\\}\n\nDeletes the specified item from the current cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/{cart_item_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\ncart\\_item\\_id\n\n\n\nSys\\_id of the item to delete from the current cart.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|204|Indicates that the request completed successfully and the specified item was deleted from the cart.|\n|400|Indicates that either the specified **cart\\_item\\_id** is invalid or the user does not have access to the cart item.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n|Name|Description|\n|----|-----------|\n|None||\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc\" \\\n--request DELETE \\\n--user \"username\":\"password\"\n```\n\n```\nNone\n```\n\n## Service Catalog - DELETE /sn\\_sc/servicecatalog/cart/\\{sys\\_id\\}/empty\n\nDeletes a specified cart, and the contents of the cart.\n\nThe capabilities of what a user can delete \\(items and/or cart\\) depends on the role in which they use to authenticate.\n\nUser roles needed to delete cart and cart contents:\n\n- admin/catalog\\_admin: Can empty any user cart.\n- admin: Can delete the cart after all the contents of the cart are deleted.\n- catalog\\_admin: Can delete all the items in the cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/{sys_id}/empty`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the cart to empty and delete.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n204\n\n\n\nRequest completed successfully and both empties and deletes the cart.\n\n
\n\n400\n\n\n\nIndicates an error for one of the following reasons:- Invalid cartId.\n- User does not have admin/catalog\\_admin role, or is trying to empty another user cart.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n|Name|Description|\n|----|-----------|\n|None||\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty\" \\\n--request DELETE \\\n--user 'username':'password'\n```\n\n```\nNone\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/cart\n\nRetrieves the details of the items within the logged in user's cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Indicates that the request completed successfully. If there is no item in the cart, it returns basic cart information and pricing for user. If the cart contains any items, then the information about the items and their individual pricing is also included.|\n|400|Indicates that the cart is empty and cannot check out.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nParameter\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nSys\\_id of the cart.Data type: String\n\n
\n\n<recurring\\_frequency>\n\n\n\nList of items in the cart having a specific recurring frequency. Possible values include:- daily\n- monthly\n- yearly\n- none \\(no recurring fees\\)\n\n Data type: Object\n\n ```\n\"\": {\n \"frequency_label\": \"String\",\n \"items\": [Array],\n \"show_subtotal_price\": \"String\",\n \"subtotal_price\": \"String\",\n \"subtotal_recurring_frequency\": \"String\",\n \"subtotal_recurring_price\": \"String\",\n \"subtotal_title\": \"String\",\n \"total_title\": \"String\"\n```\n\n
\n\n<recurring\\_frequency>.frequency\\_label\n\n\n\nFrequency of the associated recurring fee.Data type: String\n\n Default: Null\n\n
\n\n<recurring\\_frequency>.items\n\n\n\nList of objects that contain details of each item associated with the specified recurring frequency category.Data type: Array\n\n ```\n\"items\": [{\n \"cart_item_id\": \"String\",\n \"catalog_item_id\": \"String\",\n \"created.by\": \"String\",\n \"created_on\": \"String\",\n \"delivery_time\": \"String\",\n \"item_id\": \"String\",\n \"item_name\": \"String\",\n \"localized_price\": \"String\",\n \"localized_recurring_price\": \"String\",\n \"name\": \"String\",\n \"order_guide\": \"String\",\n \"picture\": \"String\",\n \"price\": \"String\",\n \"quantity\": \"String\",\n \"recurring_frequency\": \"String\",\n \"recurring_price\": \"String\",\n \"recurring_subtotal\": Number,\n \"recurring_subtotal_price\": \"String\",\n \"short_description\": \"String\",\n \"show_price\": Boolean,\n \"show_quantity\": Boolean,\n \"show_recurring_price\": Boolean,\n \"subtotal\": Number,\n \"subtotal_price\": \"String\",\n \"sys_class_name\": \"String\",\n \"sys_id\": \"String\",\n \"updated_by\": \"String\",\n \"updated_on\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\n<recurring\\_frequency>.items.cart\\_item\\_id\n\n\n\nSys\\_id of the item in this cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.catalog\\_item\\_id\n\n\n\nSys\\_id of catalog associated the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created.by\n\n\n\nUser that initially placed the item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created\\_on\n\n\n\nDate on which the item was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.delivery\\_time\n\n\n\nTime that the specified item takes to be delivered.Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_id\n\n\n\nCatalog sys\\_id of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_name\n\n\n\nName of the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_price\n\n\n\nPrice of the item in local currency.Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_recurring\\_price\n\n\n\nRecurring fee for the specified item in local currency.Data type: String\n\n
\n\n<recurring\\_frequency>.items.name\n\n\n\nItem name.Data type: String\n\n
\n\n<recurring\\_frequency>.items.order\\_guide\n\n\n\nName of the order guide to which this item is associated.Data type: String\n\n
\n\n<recurring\\_frequency>.items.picture\n\n\n\nFile name of the picture of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.price\n\n\n\nPrice of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.quantity\n\n\n\nNumber of the specified item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_frequency\n\n\n\nHow often the recurring fee is charged for the specified item.Data type: String\n\n Default: Null\n\n
\n\n<recurring\\_frequency>.items.recurring\\_price\n\n\n\nRecurring fee for the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\n\n\n\nSubtotal of the recurring fees for the item \\(**recurring\\_price** x **quantity**\\).Data type: Number\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\\_price\n\n\n\nSubtotal of the recurring fees for the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.short\\_description\n\n\n\nShort description of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.show\\_price\n\n\n\nFlag that indicates whether the price of the item is shown in the cart.Possible values:\n\n- true: Show the price of the item in the cart.\n- false: Do not show the price of the item in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show\\_quantity\n\n\n\nFlag that indicates whether to show the item quantity in the cart.Possible values:\n\n- true: Show the item quantity in the cart.\n- false: Do not show the item quantity in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show\\_recurring\\_price\n\n\n\nFlag that indicates whether the recurring fees should appear in the cart.Possible values:\n\n- true: Show the recurring fees in the cart.\n- false: Do not show the recurring fees in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.subtotal\n\n\n\nSubtotal number of items.Data type: Number\n\n
\n\n<recurring\\_frequency>.items.subtotal\\_price\n\n\n\nSubtotal for the item \\(**price** x **quantity**\\).Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_class\\_name\n\n\n\nSystem classification name of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_id\n\n\n\nSys\\_id of the item record.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_by\n\n\n\nUser that updated the item after it was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_on\n\n\n\nLast date/time on which the item was either initially placed in the cart or updated.Data type: String\n\n
\n\n<recurring\\_frequency>.items.variables\n\n\n\nList of name/value pairs of the item variables.Data type: Object\n\n
\n\n<recurring\\_frequency>.show\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show a subtotal for the associated recurring fee category.Possible values:\n\n- true: Show subtotals in the cart.\n- false: Do not show subtotals in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.subtotal\\_price\n\n\n\nSubtotal of the cost of all items for the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc. Same as **subtotal\\_recurring\\_frequency**.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring fees of the items within the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_title\n\n\n\nIf the **show\\_subtotal\\_price** is set to `true`, the text to display in the cart for the associated subtitle.Data type: String\n\n
\n\n<recurring\\_frequency>.total\\_title\n\n\n\nText to display for the total title for the associated recurring frequency category.Data type: String\n\n
\n\nshow\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show the subtotal price in the cart.Possible values:\n\n- true: Show subtotals in the cart.\n- false: Do not show subtotals in the cart.\n\n Data type: String\n\n
\n\nsubtotal\\_price\n\n\n\nSubtotal of all items in the cart in whole dollars.Data type: String\n\n
\n\nsubtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc. Same as **<recurring\\_frequency>.subtotal\\_recurring\\_frequency**.Data type: String\n\n
\n\nsubtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring frequency fees for all items in the cart.Data type: String\n\n
\n\nsubtotal\\_title\n\n\n\nText to display in the cart for the subtotal field title.Data type: String\n\n
\n\ntotal\\_title\n\n\n\nText to display in the cart for the total field title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/cart\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"6d88bc29137d2300027879d96144b04b\",\n \"subtotal_price\": \"$1,598.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"none\": {\n \"subtotal_price\": \"$1,598.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"frequency_label\": null,\n \"items\": [\n {\n \"updated_on\": \"2018-11-15 14:24:00\",\n \"catalog_item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"short_description\": \"Apple iPhone 7 \",\n \"recurring_subtotal_price\": \"$0.00\",\n \"delivery_time\": \"2 Days\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"1f88bc29137d2300027879d96144b056\",\n \"price\": \"$799.00\",\n \"recurring_frequency\": null,\n \"subtotal_price\": \"$799.00\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"recurring_price\": \"$0.00\",\n \"show_price\": true,\n \"item_name\": \"Apple iPhone7\",\n \"cart_item_id\": \"1f88bc29137d2300027879d96144b056\",\n \"recurring_subtotal\": 0,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"e823ee6b0bf00300eba42da0d5673a95.iix\",\n \"created_on\": \"2018-11-15 14:24:00\",\n \"localized_price\": \"$799.00\",\n \"subtotal\": 799,\n \"show_recurring_price\": false,\n \"name\": \"Apple iPhone7\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$0.00\",\n \"order_guide\": \"\"\n },\n ],\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/cart/delivery\\_address/\\{user\\_id\\}\n\nRetrieves the shipping address of the specified user based on the **glide.sc.req\\_for.roles** property and the default behavior configured in the **glide.sc.req\\_for.roles.defaultproperty**.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/delivery_address/{user_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nuser\\_id\n\n\n\nSys\\_id of the user whose shipping address to retrieve.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully; returns the shipping address of the specified user.|\n|400|User sys\\_id is invalid.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nAddress of the specified user.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n'result': '25 New Chardon Street, Boston\\nBoston, MA, 02114-1801\\nUSA'\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/catalogs\n\nRetrieves a list of catalogs to which the user has access based on the passed in parameters.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/catalogs`\n\nDefault URL: `/api/sn_sc/servicecatalog/catalogs`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. This limit is applied before ACL evaluation. If no records return, including records you have access to, rearrange the record order so records you have access to return first.\n\n**Note:** Unusually large **sysparm\\_limit** values can impact system performance.\n\nData type: Number\n\nDefault: 10000\n\n
\n\nsysparm\\_text\n\n\n\nKeyword to search for in the \"title\" field of the available service catalogs.Data type: String\n\n
\n\nsysparm\\_view\n\n\n\nDevice on which the item can display: - **desktop**: On the desktop.\n- **mobile**: On a mobile device.\n- **both**: Both on a desktop and on a mobile device.\n\n Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Indicates that the request completed successfully. If a valid query returns no results, the response body only contains an empty result array.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ndescription\n\n\n\nDescription of the catalog.Data type: String\n\n
\n\ndesktop\\_image\n\n\n\nImage that appears on the desktop for this catalog.Data type: String\n\n
\n\nhas\\_categories\n\n\n\nFlag that indicates whether the catalog contains categories.Possible values:\n\n- true: Catalog contains categories.\n- false: Catalog does not contain categories.\n\n Data type: Boolean\n\n
\n\nhas\\_items\n\n\n\nFlag that indicates whether the catalog contains items.Possible values:\n\n- true: Catalog contains items.\n- false: Catalog does not contain items.\n\n Data type: Boolean\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the catalog.Data type: String\n\n
\n\ntitle\n\n\n\nCatalog title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": [\n {\n \"title\": \"Technical Catalog\",\n \"sys_id\": \"742ce428d7211100f2d224837e61036d\",\n \"has_categories\": true,\n \"has_items\": true,\n \"description\": \"Products and services for the IT department\",\n \"desktop_image\": \"7a7c8271475211002ee987e8dee4906d.iix\"\n },\n {\n \"title\": \"Service Catalog\",\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"has_categories\": true,\n \"has_items\": true,\n \"description\": \"Service Catalog - IT Now\",\n \"desktop_image\": \"adbcc271475211002ee987e8dee49001.iix\"\n }\n ]\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/catalogs/\\{sys\\_id\\}/categories\n\nRetrieves the list of available categories for the specified catalog.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories`\n\nDefault URL: `/api/sn_sc/servicecatalog/catalogs/{sys_id}/categories`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the catalog whose categories are requested.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. This limit is applied before ACL evaluation. If no records return, including records you have access to, rearrange the record order so records you have access to return first.\n\n**Note:** Unusually large **sysparm\\_limit** values can impact system performance.\n\nData type: Number\n\nDefault: 10000\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_top\\_level\\_only\n\n\n\nOnly return those categories whose parent is a catalog.Valid values:\n\n- true: Only return those categories whose parent is a catalog.\n- false: Return all categories.\n\n Data type: Boolean\n\n
\n\nsysparm\\_view\n\n\n\nUI view for which to render the data. Determines the fields returned in the response.Valid values:\n\n- desktop\n- mobile\n- both\n\nIf you also specify the **sysparm\\_fields** parameter, it takes precedent.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Returns a list of categories in a catalog. If there are no query results, then an empty array is returned.|\n|400|Indicates that the request or catalog sys\\_id is invalid.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncount\n\n\n\nNumber of items within the category.Data type: Number\n\n
\n\ndescription\n\n\n\nBrief category description.Data type: String\n\n
\n\nfull \\_description\n\n\n\nDetailed category description.Data type: String\n\n
\n\nheader\\_icon\n\n\n\nIcon used on category headers.Data type: String\n\n
\n\nhomepage\\_image\n\n\n\nImage that appears for this category on the category's home page.Data type: String\n\n
\n\nicon\n\n\n\nIcon to use to signify this category.Data type: String\n\n
\n\nsubcategories\n\n\n\nList of subcategories within the category.Data type: Array\n\n ```\n\"subcategories\": [\n \"sys_id\": \"String\",\n \"title\": \"String\n]\n```\n\n
\n\nsubcategories.sys\\_id\n\n\n\nSys\\_id of the subcategory.Data type: String\n\n
\n\nsubcategories.title\n\n\n\nTitle of the subcategory.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the category.Data type: String\n\n
\n\ntitle\n\n\n\nCategory title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": [\n {\n \"title\": \"Can We Help You?\",\n \"description\": \"Your IT gateway. Report issues and submit requests.\\n\\t\\t\",\n \"full_description\": null,\n \"icon\": \"\",\n \"header_icon\": \"\",\n \"homepage_image\": \"29f8ffa9471211002ee987e8dee4905e.iix\",\n \"count\": 14,\n \"subcategories\": [],\n \"sys_id\": \"e15706fc0a0a0aa7007fc21e1ab70c2f\"\n },\n {\n \"title\": \"Departmental Services\",\n \"description\": \"Services offered by different departments in the organization\",\n \"full_description\": null,\n \"icon\": \"\",\n \"header_icon\": \"\",\n \"homepage_image\": \"6fb4a1d95f2211001c9b2572f2b47748.iix\",\n \"count\": 1,\n \"subcategories\": [],\n \"sys_id\": \"95fc11615f1211001c9b2572f2b477c6\"\n },\n {\n \"title\": \"Desktops\",\n \"description\": \"Desktop computers for your work area.\",\n \"full_description\": null,\n \"icon\": \"\",\n \"header_icon\": \"\",\n \"homepage_image\": \"1bface31475211002ee987e8dee49095.iix\",\n \"count\": 1,\n \"subcategories\": [],\n \"sys_id\": \"900682363731300054b6a3549dbe5d5f\"\n }\n ]\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/catalogs/\\{sys\\_id\\}\n\nRetrieves the available information for a specified catalog.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/catalogs/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the catalog to retrieve.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_view\n\n\n\nDevice on which the item can display: - **desktop**: On the desktop.\n- **mobile**: On a mobile device.\n- **both**: Both on a desktop and on a mobile device.\n\n Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request has completed successfully and returns the available information for the specified catalog.\n\n
\n\n400\n\n\n\nIndicates that request is invalid for one of the following reasons:- User does not have access to the catalog.\n- Invalid sys\\_id.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncategories\n\n\n\nList of objects that describe categories within the catalog.Data type: Array\n\n ```\n\"categories\": [\n \"description\": \"String\",\n \"header_image\": \"String\",\n \"sys_id\": \"String\",\n \"title\": \"String\n]\n```\n\n
\n\ncategories.description\n\n\n\nDescription of the category.Data type: String\n\n
\n\ncategories.header\\_image\n\n\n\nCategory header image.Data type: String\n\n
\n\ncategories.sys\\_id\n\n\n\nUnique category identifier \\(sys\\_id\\).Data type: String\n\n
\n\ncategories.title\n\n\n\nCategory title.Data type: String\n\n
\n\ndescription\n\n\n\nCatalog description.Data type: String\n\n
\n\ndesktop\\_image\n\n\n\nSource of the image that displays with the catalog in the desktop view.Data type: String\n\n
\n\nhas\\_categories\n\n\n\nFlag that indicates whether the catalog has categories.Possible values:\n\n- true: Catalog has categories.\n- false: Catalog does not have categories.\n\n Data type: Boolean\n\n
\n\nhas\\_items\n\n\n\nFlag that indicates whether there are items within the category. Possible values:\n\n- true: Catalog has items associated with it.\n- false: Catalog does not have any items associated with it.\n\n Data type: Boolean\n\n
\n\nsys\\_id\n\n\n\nUnique catalog sys\\_id.Data type: String\n\n
\n\ntitle\n\n\n\nCatalog title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.comaqsw\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"title\": \"Customer Service\",\n \"sys_id\": \"65bcd377c3011200b12d9f2974d3aea0\",\n \"has_categories\": true,\n \"categories\": [\n {\n \"header_image\": \"\",\n \"sys_id\": \"4cb69d19c3921200b0449f2974d3ae69\",\n \"description\": null,\n \"title\": \"Services\"\n },\n {\n \"header_image\": \"\",\n \"sys_id\": \"1b8611d5c3921200b0449f2974d3ae12\",\n \"description\": null,\n \"title\": \"Support\"\n }\n ],\n \"has_items\": true,\n \"description\": \"Customer Service\",\n \"desktop_image\": \"\"\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/categories/\\{sys\\_id\\}\n\nRetrieves the available information for a specified category.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/categories/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the category for which to return information.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_view\n\n\n\nUI view for which to render the data. Determines the fields returned in the response.Valid values:\n\n- desktop\n- mobile\n- both\n\nIf you also specify the **sysparm\\_fields** parameter, it takes precedent.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nSuccessful. The request was successfully processed.\n\n
\n\n400\n\n\n\nIndicates that request is invalid for one of the following reasons:- User does not have access to the category.\n- Invalid sys\\_id.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nchild\\_categories\n\n\n\nList of objects that describe the child categories that belong to this category. Data type: Array\n\n ```\n\"child_categories\": [\n \"count\": Number,\n \"isParentCategory\": \"String\",\n \"parent\": \"String\",\n \"subcategories\": [Array],\n \"sys_id\": \"String\",\n \"title\": \"String\"\n]\n```\n\n
\n\nchild\\_categories.count\n\n\n\nNumber of items in the child category.Data type: Number\n\n
\n\nchild\\_categories.isParentCategory\n\n\n\nFlag that indicates if this is a parent category.Possible values:\n\n- true: Parent category.\n- false: Not the parent category.\n\n Data type: Boolean\n\n
\n\nchild\\_categories.parent\n\n\n\nSys\\_id of the child category's parent.Data type: String\n\n
\n\nchild\\_categories.subcategories\n\n\n\nList of objects that describe the subcategories for this child category.Data type: Array\n\n ```\n\"subcategories\": [\n \"sys_id\": \"String\",\n \"title\": \"String\"\n]\n```\n\n
\n\nchild\\_categories.subcategories.sys\\_id\n\n\n\nSys\\_id of the child subcategory.Data type: String\n\n
\n\nchild\\_categories.subcategories.title\n\n\n\nChild subcategory title.Data type: String\n\n
\n\nchild\\_categories.sys\\_id\n\n\n\nSys\\_id of the child category.Data type: String\n\n
\n\nchild\\_categories.title\n\n\n\nChild category title.Data type: String\n\n
\n\ndescription\n\n\n\nShort category description.Data type: String\n\n
\n\nfull\\_description\n\n\n\nDetailed category description.Data type: String\n\n
\n\nheader\\_icon\n\n\n\nSource of the icon displayed beside the category header when the category is listed at the top-level category.Data type: String\n\n
\n\nhomepage\\_image\n\n\n\nSource of the home page image for the category.Data type: String\n\n
\n\nicon\n\n\n\nSource of the small icon displayed beside the category name when the category is listed as a subcategory.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the category.Data type: String\n\n
\n\ntitle\n\n\n\nCategory title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"title\": \"Office\",\n \"description\": \"Office services such as printing, supplies requisition\\n\\t\\t\\tand document shipping and delivery.\\n\\t\\t\",\n \"full_description\": null,\n \"icon\": \"\",\n \"header_icon\": \"\",\n \"homepage_image\": \"498b0271475211002ee987e8dee490ea.iix\",\n \"sys_id\": \"109cdff8c6112276003b17991a09ad65\",\n \"child_categories\": [\n {\n \"sys_id\": \"109f0438c6112276003ae8ac13e7009d\",\n \"title\": \"Services\",\n \"count\": 16,\n \"parent\": \"109cdff8c6112276003b17991a09ad65\",\n \"subcategories\": [],\n \"isParentCategory\": false\n }\n ]\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/items\n\nRetrieves a list of catalog items based on the specified parameters.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items`\n\nDefault URL: `/api/sn_sc/servicecatalog/items`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_catalog\n\n\n\nCatalog sys\\_id of the item. Use this parameter to locate items in a specific catalog.Data type: String\n\n
\n\nsysparm\\_category\n\n\n\nCategory sys\\_id of the item. Use this parameter to locate catalog items in a specific category.Data type: String\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. This limit is applied before ACL evaluation. If no records return, including records you have access to, rearrange the record order so records you have access to return first.\n\n**Note:** Unusually large **sysparm\\_limit** values can impact system performance.\n\nData type: Number\n\nDefault: 10000\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_text\n\n\n\nSpecific text for which to search for in the category items. For example, `sysparm_text=\"iPhone\"` or `sysparm_text=\"Mobile devices\"`.Data type: String\n\n
\n\nsysparm\\_type\n\n\n\nType of item.Valid search values:\n\n - Record Producer\n- Order Guide\n\nIf any other value is passed, the information is ignored.Data type: String\n\n
\n\nsysparm\\_view\n\n\n\nUI view for which to render the data. Determines the fields returned in the response.Valid values:\n\n- desktop\n- mobile\n- both\n\nIf you also specify the **sysparm\\_fields** parameter, it takes precedent.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Returns a list of catalogs and items based on the specified parameters. If a valid query results in no items, then the response body contains only an empty result array.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nParameter\n\n\n\nDescription\n\n
\n\ncatalogs\n\n\n\nList of objects that describe the catalogs that contain this item.Data type: Array\n\n ```\n\"catalogs\": [{\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}]\n```\n\n
\n\ncatalogs.sys\\_id\n\n\n\nSys\\_id of the catalog.Data type: String\n\n
\n\ncatalogs.title\n\n\n\nCatalog title.Data type: String\n\n
\n\ncategory\n\n\n\nDescribes the category that contains this item.Data type: Object\n\n ```\n\"catalogs\": {\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}\n```\n\n
\n\ncategory.sys\\_id\n\n\n\nSys\\_id of the category.Data type: String\n\n
\n\ncategory.title\n\n\n\nCategory titleData type: String\n\n
\n\ncontent\\_type\n\n\n\nType of content.Data type: String\n\n
\n\ndescription\n\n\n\nDetailed description of the item.Data type: String\n\n
\n\nicon\n\n\n\nSource of the small icon displayed beside the item name.Data type: String\n\n
\n\nkb\\_article\n\n\n\nKnowledge based article associated with the item.Data type: String\n\n
\n\nlocal\\_currency\n\n\n\nCountry currency code for the local currency.Data type: String\n\n
\n\nlocalized\\_price\n\n\n\nPrice of the item expressed in the currency defined by **local\\_currency**.Data type: String\n\n
\n\nlocalized\\_recurring\\_price\n\n\n\nPrice of the recurring fee expressed in the currency defined by **local\\_currency**.Data type: String\n\n
\n\nname\n\n\n\nName of the item.Data type: String\n\n
\n\norder\n\n\n\nPre-defined order to which the item belongs.Data type: Number\n\n
\n\npicture\n\n\n\nPath to the image to display for the item.Data type: String\n\n
\n\nprice\n\n\n\nPrice of item expressed in the currency defined by **price\\_currency**.Data type: String\n\n
\n\nprice\\_currency\n\n\n\nCountry currency code for which the item price is expressed.Data type: String\n\n
\n\nrecurring\\_frequency\n\n\n\nFrequency at which the recurring fees are applied, such as daily, monthly, or yearly; null if there are no fees for the item.Data type: String\n\n
\n\nrecurring\\_price\n\n\n\nAmount of the recurring fee associated with the item.Data type: String\n\n
\n\nrecurring\\_price\\_currency\n\n\n\nCountry currency code for which the recurring fees are expressed.Data type: String\n\n
\n\nshort\\_description\n\n\n\nBrief description of the item.Data type: String\n\n
\n\nshow\\_price\n\n\n\nFlag that indicates whether to show item pricing in the cart. Possible values:\n\n- true: Name-value pairs are returned in the response parameters.\n- false: Name-value pairs are not returned in the response parameters.\n\n Data type: Boolean\n\n
\n\nshow\\_quantity\n\n\n\nFlag that indicates whether to display the item quantity in the cart.Possible values:\n\n- true: Display the item quantity in the cart.\n- false: Do not display the item quantity in the cart.\n\n Data type: Boolean\n\n
\n\nsys\\_class\\_name\n\n\n\nTable to which the record belongs, such as sc\\_cat\\_item\\_producer.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the item.Data type: String\n\n
\n\ntype\n\n\n\nType of item.Data type: String\n\n
\n\nurl\n\n\n\nURL of the item.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": [\n {\n \"short_description\": null,\n \"kb_article\": \"\",\n \"icon\": \"images/icons/catalog_item.gifx\",\n \"description\": \"

Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.

\",\n \"show_price\": false,\n \"type\": \"record_producer\",\n \"show_quantity\": true,\n \"sys_class_name\": \"sc_cat_item_producer\",\n \"picture\": \"\",\n \"url\": \"\",\n \"sys_id\": \"011f117a9f3002002920bde8132e7020\",\n \"content_type\": \"\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"Retire a Standard Change Template\",\n \"category\": {\n \"sys_id\": \"00728916937002002dcef157b67ffb6d\",\n \"title\": \"Template Management\"\n },\n \"order\": 30\n },\n {\n \"short_description\": null,\n \"kb_article\": \"\",\n \"icon\": \"4cc3ec3d471211002ee987e8dee490d0.iix\",\n \"description\": \"

A role delegator may delegate any role they have to any member of the specified group

\",\n \"show_price\": false,\n \"type\": \"record_producer\",\n \"show_quantity\": true,\n \"sys_class_name\": \"sc_cat_item_producer\",\n \"picture\": \"ed44b5804f889200086eeed18110c7ca.iix\",\n \"url\": \"\",\n \"sys_id\": \"01205b180a0a0b3000b6efd641d24b75\",\n \"content_type\": \"\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"Grant role delegation rights within a group\",\n \"category\": {\n \"sys_id\": \"496a3a7e0a0a0bc00089b39df14eb56e\",\n \"title\": \"Role Delegation\"\n },\n \"order\": 100\n }\n ]\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/items/\\{item\\_sys\\_id\\}/delegation/\\{user\\_sys\\_id\\}\n\nVerifies whether the specified delegated user has acquisition rights to the specified service catalog item.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nitem\\_sys\\_id\n\n\n\nSys\\_id of the service catalog item to verify whether the specified user has acquisition rights.Data type: String\n\nTable: Service Catalog \\[sc\\_catalog\\]\n\n
\n\nuser\\_sys\\_id\n\n\n\nSys\\_id of the user to check whether they have acquisition rights to the specified service catalog item.Data type: String\n\nTable: Users \\[sys\\_users\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nFlag that indicates whether the specified user has acquisition rights to the specified service catalog item.Valid values:\n\n- true: User has acquisition rights.\n- false: User does not have acquisition rights.\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"result\": true\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}\n\nRetrieves a specified catalog item.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the catalog item to return.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_view\n\n\n\nUI view for which to render the data. Determines the fields returned in the response.Valid values:\n\n- desktop\n- mobile\n- both\n\nIf you also specify the **sysparm\\_fields** parameter, it takes precedent.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request has completed successfully and returns the details of the catalog item.\n\n
\n\n400\n\n\n\nIndicates that request is invalid for one of the following reasons:- User does not have access to the catalog item.\n- Invalid sys\\_id.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncatalogs\n\n\n\nList of objects that describe the catalogs that contain this item.Data type: Array\n\n ```\n\"catalogs\": [{\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}]\n```\n\n
\n\ncatalogs.sys\\_id\n\n\n\nSys\\_id of the catalog.Data type: String\n\n
\n\ncatalogs.title\n\n\n\nCatalog title.Data type: String\n\n
\n\ncategories\n\n\n\nList of objects that describe the categories that contains this item.Data type: Array\n\n ```\n\"categories\": [{\n \"active\": Boolean,\n \"category\": {Object},\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}]\n```\n\n
\n\ncategories.active\n\n\n\nFlag that indicates whether the category is active.Possible values:\n\n- true: Category is active.\n- false: Category is inactive.\n\n Data type: Boolean\n\n
\n\ncategories.category\n\n\n\nDescribes the associated category.Data type: Object\n\n ```\n\"category\": {\n \"active\": Boolean,\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}\n```\n\n
\n\ncategories.category.active\n\n\n\nFlag that indicates whether the category is active.Possible values:\n\n- true: Category is active.\n- false: Category is inactive.\n\n Data type: Boolean\n\n
\n\ncategories.category.sys\\_id\n\n\n\nSys\\_id of the category.Data type: String\n\n
\n\ncategories.category.title\n\n\n\nCategory title.Data type: String\n\n
\n\ncategories.sys\\_id\n\n\n\nParent category of the category specified in **categories.category**.Data type: String\n\n
\n\ncategory\n\n\n\nPrimary category to which the item belongs.Data type: Object\n\n ```\n\"category\": {\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}\n```\n\n
\n\ncategory.sys\\_id\n\n\n\nSys\\_id of the primary category.Data type: String\n\n
\n\ncategory.title\n\n\n\nPrimary category's title.Data type: String\n\n
\n\nclient\\_script\n\n\n\nList of all the catalog client scripts defined on the catalog item.Data type: Object\n\n ```\n\"client_script\": {\n \"onChange\": [Array],\n \"onLoad\": [Array],\n \"onSubmit\": [Array]\n}\n```\n\n
\n\nclient\\_script.onChange\n\n\n\nList of onChange client scripts associated with the item.Data type: Array\n\n
\n\nclient\\_script.onSubmit\n\n\n\nList of onSubmit client scripts associated with the item.Data type: Array\n\n
\n\nclient\\_script.onLoad\n\n\n\nList of onLoad client scripts associated with the item.Data type: Array\n\n
\n\ncontent\\_type\n\n\n\nType of content.Data type: String\n\n
\n\ndata\\_lookup\n\n\n\nList of data lookups defined on the catalog item.Data type: Array\n\n
\n\ndescription\n\n\n\nDetailed description of the item.Data type: String\n\n
\n\nicon\n\n\n\nSource of the small icon displayed beside the item name.Data type: String\n\n
\n\nkb\\_article\n\n\n\nKnowledge based article associated with the item.Data type: String\n\n
\n\nlocal\\_currency\n\n\n\nCountry currency code for the local currency.Data type: String\n\n
\n\nlocalized\\_price\n\n\n\nPrice of the item expressed in the currency defined by **local\\_currency**.Data type: String\n\n
\n\nlocalized\\_recurring\\_price\n\n\n\nPrice of the recurring fee expressed in the currency defined by **local\\_currency**.Data type: String\n\n
\n\nname\n\n\n\nName of the item.Data type: String\n\n
\n\norder\n\n\n\nNumber of orders for the item.Data type: Number\n\n
\n\npicture\n\n\n\nFile name of the image to display for the item.Data type: String\n\n
\n\nprice\n\n\n\nPrice of item expressed in the currency defined by **price\\_currency**.Data type: String\n\n
\n\nprice\\_currency\n\n\n\nCountry currency code for which the item price is expressed.Data type: String\n\n
\n\nrecurring\\_frequency\n\n\n\nFrequency at which the recurring fees are applied, such as daily, monthly, or yearly.Data type: String\n\n
\n\nrecurring\\_price\n\n\n\nAmount of the recurring fee associated with the itemData type: String\n\n
\n\nrecurring\\_price\\_currency\n\n\n\nCountry currency code for which the recurring fees are expressed.Data type: String\n\n
\n\nshort\\_description\n\n\n\nBrief description of the item.Data type: String\n\n
\n\nshow\\_price\n\n\n\nFlag that indicates whether to show item pricing in the cart.Possible values:\n\n- true: Pricing name/value pairs are returned in the response parameters.\n- false: Pricing name/value pairs are not returned in the response parameters.\n\n Data type: Boolean\n\n
\n\nshow\\_quantity\n\n\n\nFlag that indicates whether to display the item quantity in the cart.Possible values:\n\n- true: Display the item quantity in the cart.\n- false: Do not display the item quantity in the cart.\n\n Data type: Boolean\n\n
\n\nsys\\_class\\_name\n\n\n\nName of the table to which this record belongs.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the item.Data type: String\n\n
\n\ntype\n\n\n\nType of item.Data type: String\n\n
\n\nui\\_policy\n\n\n\nList of UI policies associated with the item.Data type: Array\n\n
\n\nurl\n\n\n\nURL of item image.Data type: String\n\n
\n\nvariables\n\n\n\nList of available variables associated with the item.Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec\" \\\n --request GET \\\n --header \"Accept:application/json\" \\\n --user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"short_description\": \"Apple iPad 3\",\n \"kb_article\": \"\",\n \"icon\": \"e6b3bc0647311200e0ef563dbb9a71fc.iix\",\n \"description\": \"\\n\\t\\t\\t

\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\tiPad with Retina display Wi-Fi 16GB - Black \\n\\t\\t\\t\\t\\n\\t\\t\\t

\\n\\t\\t\\t

\\n\\t\\t\\t\\tKey Features:\\n\\t\\t\\t

\\n\\t\\t\\t\",\n \"show_price\": true,\n \"recurring_price\": \"$0.00\",\n \"type\": \"catalog_item\",\n \"show_quantity\": true,\n \"local_currency\": \"USD\",\n \"sys_class_name\": \"pc_hardware_cat_item\",\n \"picture\": \"5b977690cb921200f2de77a4634c9c6a.iix\",\n \"url\": \"\",\n \"sys_id\": \"060f3afa3731300054b6a3549dbe5d3e\",\n \"recurring_price_currency\": \"USD\",\n \"content_type\": \"\",\n \"localized_price\": \"$600.00\",\n \"price\": \"$600.00\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"recurring_frequency\": null,\n \"name\": \"Apple iPad 3\",\n \"localized_recurring_price\": \"$0.00\",\n \"category\": {\n \"sys_id\": \"b06546f23731300054b6a3549dbe5dd8\",\n \"title\": \"Tablets\"\n },\n \"price_currency\": \"USD\",\n \"order\": 0,\n \"categories\": [\n {\n \"sys_id\": \"d258b953c611227a0146101fb1be7c31\",\n \"active\": true,\n \"category\": {\n \"sys_id\": \"b06546f23731300054b6a3549dbe5dd8\",\n \"active\": true,\n \"title\": \"Tablets\"\n },\n \"title\": \"Hardware\"\n }\n ],\n \"variables\": [],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/wishlist\n\nRetrieves the list of items in the logged in user's wish list.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/wishlist`\n\nDefault URL: `/api/sn_sc/servicecatalog/wishlist`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nSys\\_id of the wish list cart.Data type: String\n\n
\n\nitems\n\n\n\nList of objects that describe the items in the wish list cart.Data type: Array\n\n ```\n\"items\": [{\n \"cart_item_id\": \"String\",\n \"catalog_item_id\": \"String\",\n \"created_by\": \"String\",\n \"created_on\": \"String\",\n \"delivery_time\": \"String\",\n \"item_id\": \"String\",\n \"item_name\": \"String\",\n \"localized_price\": \"String\",\n \"localized_recurring_price\": \"String\",\n \"name\": \"String\",\n \"order_guide\": \"String\",\n \"picture\": \"String\",\n \"price\": \"String\",\n \"quantity\": \"String\",\n \"recurring_frequency\": \"String\",\n \"recurring_price\": \"String\",\n \"recurring_subtotal\": Number,\n \"recurring_subtotal_price\": \"String\",\n \"short_descriptions\": \"String\",\n \"show_price\": Boolean,\n \"show_quantity\": Boolean,\n \"show_recurring_price\": Boolean,\n \"subtotal\": Number,\n \"subtotal_price\": \"String\",\n \"sys_class_name\": \"String\",\n \"sys_id\": \"String\",\n \"updated_by\": \"String\",\n \"updated_on\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\nitems.cart\\_item\\_id\n\n\n\nSys\\_id of the item. Same as **items.sys\\_id**.Data type: String\n\n
\n\nitems.catalog\\_item\\_id\n\n\n\nSys\\_id of the catalog identifier for this item in the wish list cart. Same as **items.item\\_id**.Data type: String\n\n
\n\nitems.created\\_by\n\n\n\nUser that initially put the item in the wish list cart.Data type: String\n\n
\n\nitems.created\\_on\n\n\n\nDate and time that the item was initially placed in the wishlist cart.Data type: String\n\n
\n\nitems.delivery\\_time\n\n\n\nAmount of time that it takes to deliver the item.Data type: String\n\n
\n\nitems.item\\_id\n\n\n\nUnique catalog identifier for this item in the wish list cart \\(sys\\_id\\). Same as items.catalog\\_item\\_id.Data type: String\n\n
\n\nitems.item\\_name\n\n\n\nName of the item.Data type: String\n\n
\n\nitems.localized\\_price\n\n\n\nPrice of the item expressed in the local currency.Data type: String\n\n
\n\nitems.localized\\_recurring\\_price\n\n\n\nPrice of the recurring fee expressed in the local currency.Data type: String\n\n
\n\nitems.name\n\n\n\nName of the item.Data type: String\n\n
\n\nitems.order\\_guide\n\n\n\nOrder guide to which the item is associated.Data type: String\n\n
\n\nitems.picture\n\n\n\nPath to the image to display for the item.Data type: String\n\n
\n\nitems.price\n\n\n\nPrice of item.Data type: String\n\n
\n\nitems.quantity\n\n\n\nNumber of this item in the wish list cart.Data type: String\n\n
\n\nitems.recurring\\_frequency\n\n\n\nFrequency at which the recurring fees are applied, such as daily, monthly, or yearly. Null if no recurring fees for this item.Data type: String\n\n
\n\nitems.recurring\\_price\n\n\n\nAmount of the recurring fee associated with the item.Data type: String\n\n
\n\nitems.recurring\\_subtotal\n\n\n\nSubtotal for the recurring fees for this item \\(recurring\\_price x quantity\\).Data type: Number\n\n
\n\nitems.recurring\\_subtotal\\_price\n\n\n\nSubtotal for the recurring fees for this item \\(recurring\\_price x quantity\\).Data type: String\n\n
\n\nitems.short\\_description\n\n\n\nBrief description of the item.Data type: String\n\n
\n\nitems.show\\_price\n\n\n\nFlag that indicates whether to show item pricing in the cart. If this parameter is set to \"false\", pricing name/value pairs are not returned in the response parameters.Data type: Boolean\n\n
\n\nitems.show\\_quantity\n\n\n\nFlag that indicates whether to display the item quantity in the cart.Data type: Boolean\n\n
\n\nitems.show\\_recurring\\_price\n\n\n\nFlag that indicates whether to display the recurring fees in the cart.Data type: Boolean\n\n
\n\nitems.subtotal\n\n\n\nSubtotal for this item - not including cents \\(price x quantity\\).Data type: Number\n\n
\n\nitems.subtotal\\_price\n\n\n\nSubtotal for this item - including cents \\(price x quantity\\).Data type: String\n\n
\n\nitems.sys\\_class\\_name\n\n\n\nChild class to which the associated item record belongs.Data type: String\n\n
\n\nitems.sys\\_id\n\n\n\nUnique identifier of the item \\(sys\\_id\\). Same as items.cart\\_item\\_id.Data type: String\n\n
\n\nitems.updated\\_by\n\n\n\nUser that updated this item in the wish list cart.Data type: String\n\n
\n\nitems.updated\\_on\n\n\n\nDate and time that the item was put on the wishlist.Data type: String\n\n
\n\nitems.variables\n\n\n\nName-value pairs of variables associated with the item.Data type: Object\n\n
### cURL request\n\n```\ncurl \"http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user 'username':'password'\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"3a68c46013f12300027879d96144b0ce\",\n \"items\": [\n {\n \"updated_on\": \"2018-11-16 05:54:41\",\n \"catalog_item_id\": \"774906834fbb4200086eeed18110c737\",\n \"short_description\": \"Macbook Pro\",\n \"recurring_subtotal_price\": \"$100.00\",\n \"delivery_time\": \"5 Days 0 seconds\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"3b8d887113b5a300027879d96144b0c2\",\n \"price\": \"$1,499.00\",\n \"recurring_frequency\": \"Annually\",\n \"subtotal_price\": \"$1,499.00\",\n \"variables\": {\n \"Adobe Photoshop\": \"false\",\n \"Adobe Acrobat\": \"false\",\n \"Optional Software\": \"true\",\n \"Additional software requirements\": \"\",\n \"Eclipse IDE\": \"true\"\n },\n \"quantity\": \"1\",\n \"item_id\": \"774906834fbb4200086eeed18110c737\",\n \"recurring_price\": \"$100.00\",\n \"show_price\": true,\n \"item_name\": \"Developer Laptop (Mac)\",\n \"cart_item_id\": \"3b8d887113b5a300027879d96144b0c2\",\n \"recurring_subtotal\": 100,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"4e4efd444f889200086eeed18110c7e6.iix\",\n \"created_on\": \"2018-11-16 05:54:41\",\n \"localized_price\": \"$1,499.00\",\n \"subtotal\": 1499,\n \"show_recurring_price\": true,\n \"name\": \"Developer Laptop (Mac)\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$100.00\",\n \"order_guide\": \"\"\n }\n ]\n }\n}\n```\n\n## Service Catalog - GET /sn\\_sc/servicecatalog/wishlist/\\{cart\\_item\\_id\\}\n\nRetrieves the details of the specified item stored in the wish list cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/wishlist/{cart_item_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_item\\_id\n\n\n\nSys\\_id of the wish list cart item to retrieve.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Indicates a failed request. Incorrect cart item id or the item does not exist in the wish list cart.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_item\\_id\n\n\n\nSys\\_id of the item.Data type: String\n\n
\n\ncatalog\\_item\\_id\n\n\n\nSys\\_id of the catalog identifier for this item in the wish list cart.Data type: String\n\n
\n\ndelivery\\_time\n\n\n\nAmount of time that it takes to deliver the item.Data type: String\n\n
\n\nitem\\_name\n\n\n\nName of the item.Data type: String\n\n
\n\nlocalized\\_price\n\n\n\nPrice of the item expressed in the local currency.Data type: String\n\n
\n\nlocalized\\_recurring\\_price\n\n\n\nPrice of the recurring fee expressed in the local currency.Data type: String\n\n
\n\nprice\n\n\n\nPrice of item.Data type: String\n\n
\n\nquantity\n\n\n\nNumber of this item in the wish list cart.Data type: String\n\n
\n\nrecurring\\_frequency\n\n\n\nFrequency at which the recurring fees are applied, such as daily, monthly, or yearly. Null if no recurring fees for this item.Data type: String\n\n
\n\nrecurring\\_price\n\n\n\nAmount of the recurring fee associated with the item.Data type: String\n\n
\n\nvariables\n\n\n\nName-value pairs of the variables associated with the item.Data type: Object\n\n
### cURL request\n\n```\ncurl \"http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"catalog_item_id\": \"04b7e94b4f7b4200086eeed18110c7fd\",\n \"variables\": {\n \"Adobe Photoshop\": \"\",\n \"Adobe Acrobat\": \"\",\n \"Optional Software\": \"\",\n \"Additional software requirements\": \"\"\n },\n \"quantity\": \"1\",\n \"localized_price\": \"$1,100.00\",\n \"price\": \"$1,100.00\",\n \"recurring_frequency\": \"Annually\",\n \"localized_recurring_price\": \"$100.00\",\n \"recurring_price\": \"$100.00\",\n \"item_name\": \"Standard Laptop &\",\n \"cart_item_id\": \"d31be364c3012200d68d3b0ac3d3aecf\",\n \"delivery_time\": \"5 Days\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/cart/checkout\n\nRetrieves and processes the checkout for the current cart based on whether the two-step checkout process is enabled.\n\nIf one-step checkout, the method checks out \\(saves\\) the cart and returns the request number and the request order ID. If two-step checkout, the method returns the cart order status and all the information required for two-step checkout.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/checkout`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/checkout`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request completed successfully. Returns the total and subtotal information and information on the items in the cart. If one-step checkout, the method checks out \\(saves\\) the cart and returns the request number and the request order ID. If two-step checkout, the method returns the cart order status and all the information required for two-step checkout.\n\n
\n\n400\n\n\n\nIndicates that the cart is empty and cannot check out.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nParameter\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nSys\\_id of the cart.Data type: String\n\n
\n\ndelivery\\_address\n\n\n\nAddress to which to deliver the cart items.Data type: String\n\n
\n\n<recurring\\_frequency>\n\n\n\nList of items in the cart having a specific recurring frequency. Possible values include:- daily\n- monthly\n- yearly\n- none \\(no recurring fees\\)\n\n Data type: Object\n\n ```\n\"\": {\n \"frequency_label\": \"String\",\n \"items\": [Array],\n \"show_subtotal_price\": \"String\",\n \"subtotal_price\": \"String\",\n \"subtotal_recurring_frequency\": \"String\",\n \"subtotal_recurring_price\": \"String\",\n \"subtotal_title\": \"String\",\n \"total_title\": \"String\"\n}\n```\n\n
\n\n<recurring\\_frequency>.frequency\\_label\n\n\n\nFrequency of the associated recurring fee. If there are no recurring fees for the item, this parameter contains \"null\".Data type: String\n\n
\n\n<recurring\\_frequency>.items\n\n\n\nArray of objects that contains details of each item associated with the specified recurring frequency category.Data type: Array\n\n ```\n\"items\": [{\n \"cart_item_id\": \"String\",\n \"catalog_item_id\": \"String\",\n \"created.by\": \"String\",\n \"created_on\": \"String\",\n \"delivery_time\": \"String\",\n \"item_id\": \"String\",\n \"item_name\": \"String\",\n \"localized_price\": \"String\",\n \"localized_recurring_price\": \"String\",\n \"name\": \"String\",\n \"order_guide\": \"String\",\n \"picture\": \"String\",\n \"price\": \"String\",\n \"quantity\": \"String\",\n \"recurring_frequency\": \"String\",\n \"recurring_price\": \"String\",\n \"recurring_subtotal\": Number,\n \"recurring_subtotal_price\": \"String\",\n \"short_description\": \"String\",\n \"show_price\": Boolean,\n \"show_quantity\": Boolean,\n \"show_recurring_price\": Boolean,\n \"subtotal\": Number,\n \"subtotal_price\": \"String\",\n \"sys_class_name\": \"String\",\n \"sys_id\": \"String\",\n \"updated_by\": \"String\",\n \"updated_on\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\n<recurring\\_frequency>.items.cart\\_item\\_id\n\n\n\nSys\\_id of the item in this cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.catalog\\_item\\_id\n\n\n\nCatalog sys\\_id of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created.by\n\n\n\nUser that initially placed the item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created\\_on\n\n\n\nDate on which the item was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.delivery\\_time\n\n\n\nTime that the specified item takes to be delivered.Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_id\n\n\n\nSys\\_id of the item. Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_name\n\n\n\nName of the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_price\n\n\n\nPrice of the item in local currency.Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_recurring\\_price\n\n\n\nRecurring fee for the specified item in local currency.Data type: String\n\n
\n\n<recurring\\_frequency>.items.name\n\n\n\nItem name.Data type: String\n\n
\n\n<recurring\\_frequency>.items.order\\_guide\n\n\n\nName of the order guide to which this item is associated. If this item is not associated with an order guide this parameter contains an empty string.Data type: String\n\n
\n\n<recurring\\_frequency>.items.picture\n\n\n\nFile name of the picture of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.price\n\n\n\nPrice of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.quantity\n\n\n\nNumber of the specified item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_frequency\n\n\n\nHow often the recurring fee is charged for the specified item. If there are no recurring fees for the item, this parameter contains \"null\".Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_price\n\n\n\nRecurring fee for the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\n\n\n\nSubtotal of the recurring fees for the item \\(**recurring\\_price** x **quantity**\\).Data type: Number\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\\_price\n\n\n\nSubtotal of the recurring fees for the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.short\\_description\n\n\n\nShort description of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.show\\_price\n\n\n\nFlag that indicates whether the price of the item is shown in the cart.Possible values:\n\n- true: Show the price of the item in the cart.\n- false: Do not show the price of the item in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show\\_quantity\n\n\n\nFlag that indicates whether to show the item quantity in the cart.Possible values:\n\n- true: Show the item quantity in the cart.\n- false: Do not show the item quantity in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show\\_recurring\\_price\n\n\n\nFlag that indicates whether the recurring fees should appear in the cart.Possible values:\n\n- true: Show the recurring fees in the cart.\n- false: Do not show the recurring fees in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.subtotal\n\n\n\nSubtotal number of items.Data type: Number\n\n
\n\n<recurring\\_frequency>.items.subtotal\\_price\n\n\n\nSubtotal for the item \\(**price** x **quantity**\\).Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_class\\_name\n\n\n\nSystem classification name of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_id\n\n\n\nSys\\_id of the item record.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_by\n\n\n\nUser that updated the item after it was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_on\n\n\n\nLast date/time on which the item was either initially placed in the cart or updated.Data type: String\n\n
\n\n<recurring\\_frequency>.items.variables\n\n\n\nList of name-value pairs of the item variables.Data type: Object\n\n
\n\n<recurring\\_frequency>.show\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show a subtotal for the associated recurring fee category.Possible values:\n\n- true: Show subtotals in the cart.\n- false: Do not show subtotals in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.subtotal\\_price\n\n\n\nSubtotal of the cost of all items for the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc. Same as **subtotal\\_recurring\\_frequency**.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring fees of the items within the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_title\n\n\n\nIf the **show\\_subtotal\\_price** is set to `true`, the text to display in the cart for the associated subtitle.Data type: String\n\n
\n\n<recurring\\_frequency>.total\\_title\n\n\n\nText to display for the total title for the associated recurring frequency category.Data type: String\n\n
\n\nrequested\\_for\n\n\n\nSys\\_id of the user for whom the item was ordered.Data type: String\n\n
\n\nrequested\\_for\\_user\n\n\n\nUser that requested the item on behalf of someone else.Data type: String\n\n
\n\nshow\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show the subtotal price in the cart.Possible values:\n\n- true: Show subtotals in the cart.\n- false: Do not show subtotals in the cart.\n\n Data type: String\n\n
\n\nspecial\\_instructions\n\n\n\nAny instructions given by the customer on the item.Data type: String\n\n
\n\nsubtotal\\_price\n\n\n\nSubtotal of all items in the cart in whole dollars.Data type: String\n\n
\n\nsubtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc. Same as **<recurring\\_frequency>.subtotal\\_recurring\\_frequency**.Data type: String\n\n
\n\nsubtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring frequency fees for all items in the cart.Data type: String\n\n
\n\nsubtotal\\_title\n\n\n\nText to display in the cart for the subtotal field title.Data type: String\n\n
\n\ntotal\\_title\n\n\n\nText to display in the cart for the total field title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"0830db8413a56300397533e2e144b0ba\",\n \"subtotal_price\": \"$1,598.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"delivery_address\": \"\",\n \"special_instructions\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"requested_for_user\": \"System Administrator\",\n \"none\": {\n \"subtotal_price\": \"$1,598.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"frequency_label\": null,\n \"items\": [\n {\n \"updated_on\": \"2018-11-06 17:01:21\",\n \"catalog_item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"short_description\": \"Apple iPhone 7 \",\n \"recurring_subtotal_price\": \"$0.00\",\n \"delivery_time\": \"2 Days\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"a846872a1369e300027879d96144b07e\",\n \"price\": \"$799.00\",\n \"recurring_frequency\": null,\n \"subtotal_price\": \"$799.00\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"recurring_price\": \"$0.00\",\n \"show_price\": true,\n \"item_name\": \"Apple iPhone7\",\n \"cart_item_id\": \"a846872a1369e300027879d96144b07e\",\n \"recurring_subtotal\": 0,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"e823ee6b0bf00300eba42da0d5673a95.iix\",\n \"created_on\": \"2018-11-06 17:01:21\",\n \"localized_price\": \"$799.00\",\n \"subtotal\": 799,\n \"show_recurring_price\": false,\n \"name\": \"Apple iPhone7\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$0.00\",\n \"order_guide\": \"\"\n },\n {\n \"updated_on\": \"2018-11-06 17:34:15\",\n \"catalog_item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"short_description\": \"Apple iPhone 7 \",\n \"recurring_subtotal_price\": \"$0.00\",\n \"delivery_time\": \"2 Days\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"7d138fa21329e300027879d96144b065\",\n \"price\": \"$799.00\",\n \"recurring_frequency\": null,\n \"subtotal_price\": \"$799.00\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"recurring_price\": \"$0.00\",\n \"show_price\": true,\n \"item_name\": \"Apple iPhone7\",\n \"cart_item_id\": \"7d138fa21329e300027879d96144b065\",\n \"recurring_subtotal\": 0,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"e823ee6b0bf00300eba42da0d5673a95.iix\",\n \"created_on\": \"2018-11-06 16:47:30\",\n \"localized_price\": \"$799.00\",\n \"subtotal\": 799,\n \"show_recurring_price\": false,\n \"name\": \"Apple iPhone7\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$0.00\",\n \"order_guide\": \"\"\n }\n ],\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/cart/submit\\_order\n\nChecks out the user cart, based on the current check-out type \\(one-step or two-step\\).\n\nIf one-step checkout, the method checks out \\(saves\\) the cart and returns the request number and the request order ID. If two-step checkout, the method returns the cart order status and all the information required for two-step checkout.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/submit_order`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/submit_order`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request completed successfully and the items in the cart are successfully checked out.If one-step checkout, the method checks out \\(saves\\) the cart and returns the request number and the request order ID. If two-step checkout, the method returns the cart order status and all the information required for two-step checkout.\n\n
\n\n400\n\n\n\nIndicates that the user cart is empty.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nparent\\_id\n\n\n\nIf available, sys\\_id of the parent record from which the request is created. For more information, see [Configure a parent mapping for a request](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/configure-mapping-for-request.md).Data type: String\n\n
\n\nparent\\_table\n\n\n\nName of the parent table.Data type: String\n\n
\n\nrequest\\_id\n\n\n\nSys\\_id of the order request generated.Data type: String\n\n
\n\nrequest\\_number\n\n\n\nNumber of the request generated.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order \" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"request_number\": \"REQ0010010\",\n \"request_id\": \"f89ed597db21120064301150f0b8f5ff\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/add\\_to\\_cart\n\nAdds the specified item to the cart of the current user.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the item to add to the current cart.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_also\\_request\\_for\n\n\n\nComma-separated string of user sys\\_ids of other users for which to order the specified item.- You cannot specify more than 50 additional users to receive the item.\n- If any person in the list doesn't qualify for the item, the entire request is rejected.\n- If the associated item does not have the **requested\\_for** variable set, the request is rejected.\n- If the associated item has the **requested\\_for** variable set, but the **Enable also Request for** variable is not configured, or the calling user doesn’t have the proper roles, the request is rejected.\n\nTable: User \\[sys\\_user\\]\n\n
\n\nsysparm\\_quantity\n\n\n\nRequired. Quantity of the item. Cannot be a negative number.Data type: Number\n\n
\n\nsysparm\\_requested\\_for\n\n\n\nSys\\_id of the user for whom to order the specified item.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\nvariables\n\n\n\nName-value pairs of all mandatory cart item variables. Mandatory variables are defined on the associated form.Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nSuccessful. The request was successfully processed.\n\n
\n\n400\n\n\n\nThe following errors can occur:- Invalid quantity value: Indicates that either the **sysparm\\_quantity** parameter is not provided or contains an invalid value.\n- Security constraints prevent ordering of Item: Indicates that either the cart item sys\\_id specified in the path parameters is invalid or the user does not have access to the item.\n- Mandatory Variables are required: Indicates that one or more of the mandatory variables is not provided in the request.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nCart sys\\_id.Data type: String\n\n
\n\nitems\n\n\n\nDetails of all of the items in the cart.Data type: Array\n\n ```\n\"items\":[\n {\n \"cart_item_id\":\"String\",\n \"catalog_item_id\":\"String\",\n \"item_name\":\"String\",\n \"localized_recurring_price\":\"String\",\n \"localized_price\":\"String\",\n \"price\":\"String\",\n \"quantity\":\"String\",\n \"recurring_frequency\":\"String\",\n \"recurring_price\":\"String\"\n }\n]\n```\n\n
\n\nitems.cart\\_item\\_id\n\n\n\nSys\\_id of the item.Data type: String\n\n
\n\nitems.catalog\\_item\\_id\n\n\n\nCatalog sys\\_id of the item.Data type: String\n\n
\n\nitems.item\\_name\n\n\n\nName of the item.Data type: String\n\n
\n\nitems.localized\\_price\n\n\n\nPrice of the item, in the user's local currency.Data type: String\n\n
\n\nitems.localized\\_recurring\\_price\n\n\n\nRecurring price of the item, in the user's local currency.Data type: String\n\n
\n\nitems.price\n\n\n\nBase price.Data type: String\n\n
\n\nitems.quantity\n\n\n\nQuantity of the item in the cart.Data type: String\n\n
\n\nitems.recurring\\_frequency\n\n\n\nFrequency at which the recurring price is applied.Data type: String\n\n
\n\nitems.recurring\\_price\n\n\n\nRecurring price.Data type: String\n\n
\n\nsubtotal\n\n\n\nSubtotal of the items in the cart.Data type: String\n\n
### Sample cURL request and response\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--data \"{ 'sysparm_quantity' : '1',\n 'variables' : {\n 'acrobat' : 'true'\n }\n}\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"0951c597db21120064301150f0b8f5cf\",\n \"subtotal\": \"$1,599.98\",\n \"items\": [\n {\n \"catalog_item_id\": \"0d08837237153000158bbfc8bcbe5d02\",\n \"quantity\": \"1\",\n \"localized_price\": \"$799.99\",\n \"price\": \"$799.99\",\n \"recurring_frequency\": \"Monthly\",\n \"localized_recurring_price\": \"$30.00\",\n \"recurring_price\": \"$29.00\",\n \"item_name\": \"Apple iPhone 5\",\n \"cart_item_id\": \"ac61c597db21120064301150f0b8f5f9\"\n }\n ]\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/add\\_to\\_wishlist\n\nAdds the specified item to the wish list cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist`\n\nDefault URL: `/api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the item to add to the wish list. Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Indicates a failed request. Invalid request data or the user cannot add item to the wish list.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n|Name|Description|\n|----|-----------|\n|None||\n\n### cURL request\n\n```\ncurl \"http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist\" \\\n --request POST \\\n --header \"Accept:application/json\" \\\n --header \"Content-Type:application/json\" \\\n --data \"{\\\"sysparm_quantity\\\":\\\"1\\\"}\" \\\n --user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"02a559a7c3b02200d68d3b0ac3d3ae5d\",\n \"items\": [\n {\n \"catalog_item_id\": \"04b7e94b4f7b4200086eeed18110c7fd\",\n \"variables\": {\n \"Adobe Photoshop\": \"\",\n \"Adobe Acrobat\": \"\",\n \"Optional Software\": \"\",\n \"Additional software requirements\": \"\"\n },\n \"quantity\": \"1\",\n \"localized_price\": \"$1,100.00\",\n \"price\": \"$1,100.00\",\n \"recurring_frequency\": \"Annually\",\n \"localized_recurring_price\": \"$100.00\",\n \"recurring_price\": \"$100.00\",\n \"item_name\": \"Standard Laptop &\",\n \"cart_item_id\": \"d31be364c3012200d68d3b0ac3d3aecf\",\n \"delivery_time\": \"5 Days\"\n }\n ]\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/checkout\\_guide\n\nRetrieves an array of contents requested for checkout.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the checkout guide for which to return the information.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nitems\n\n\n\nList of object that describe the items requested for checkout. Data type: Array\n\n```\n\"items\": [{\n \"sys_id\": \"String\",\n \"sysparm_quantity\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\nitems.sys\\_id\n\n\n\nRequired. Sys\\_id of the catalog item.Data type: String\n\n
\n\nitems.sysparm\\_quantity\n\n\n\nNumber of items.Data type: String\n\n Default: 1\n\n
\n\nitems.variables\n\n\n\nName-value pairs of variables associated with the item.Data type: Object\n\n Default: No variables\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request has completed successfully.- Is not two-step: Items are added to the cart and the cart contents are returned.\n- Is two-step: Returns the request number and request sys\\_id after checkout.\n\n
\n\n400\n\n\n\nIndicates that the request is invalid. Could be due to one of the following reasons:- One or more items sent do not exist.\n- User does not have access to one or more of the items.\n- Mandatory variables of one or more items have not been answered. \\(Only variables defined as mandatory are honored.\\)\n- Quantity value is sent and is not a positive integer.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nSys\\_id of the cart.Data type: String\n\n
\n\nitems\n\n\n\nList of objects that contain details of all the items in the cart.Data type: Array\n\n ```\n\"items\": [{\n \"cart_item_id\": \"String\",\n \"catalog_item_id\": \"String\",\n \"delivery_time\": \"String\",\n \"item_name\": \"String\",\n \"localized_price\": \"String\",\n \"localized_recurring_price\": \"String\",\n \"price\": \"String\",\n \"quantity\": \"String\",\n \"recurring_frequency\": \"String\",\n \"recurring_price\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\nitems.cart\\_item\\_id\n\n\n\nSys\\_id of the item in the cart.Data type: String\n\n
\n\nitems.catalog\\_item\\_id\n\n\n\nSys\\_id of the catalog item in the cart.Data type: String\n\n
\n\nitems.delivery\\_time\n\n\n\nAmount of time it takes to deliver the item.Data type: String\n\n
\n\nitems.item\\_name\n\n\n\nName of the item in the cart.Data type: String\n\n
\n\nitems.localized\\_price\n\n\n\nPrice of the item in local currency.Data type: String\n\n
\n\nitems.localized\\_recurring\\_price\n\n\n\nRecurring price of the item in local currency.Data type: String\n\n
\n\nitems.price\n\n\n\nPrice of the item.Data type: String\n\n
\n\nitems.quantity\n\n\n\nNumber of the item in the cart.Data type: String\n\n
\n\nitems.recurring\\_frequency\n\n\n\nRecurring frequency of the item.Data type: String\n\n
\n\nitems.recurring\\_price\n\n\n\nRecurring price of the item.Data type: String\n\n
\n\nitems.variables\n\n\n\nName-value pairs associated with the item in the cart.Data type: Object\n\n
\n\nparent\\_id\n\n\n\nIf available, the sys\\_id of the parent record from which the request is created. For more information, see [Configure a parent mapping for a request](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/configure-mapping-for-request.md).Data type: String\n\n
\n\nparent\\_table\n\n\n\nName of the parent table \\(case sensitive\\).Data type: String\n\n
\n\nrequest\\_number\n\n\n\nRequest record number.Data type: String\n\n
\n\nrequest\\_id\n\n\n\nSys\\_id of the request.Data type: String\n\n
\n\nsubtotal\\_price\n\n\n\nCart subtotal.Data type: String\n\n
\n\nsubtotal\\_price\n\n\n\nSubtotal of the current frequency block.Data type: String\n\n
\n\nsubtotal\\_recurring\\_frequency\n\n\n\nRecurring frequency subtotal of the cart.Data type: String\n\n
\n\nsubtotal\\_recurring\\_frequency\n\n\n\nRecurring frequency subtotal of the current frequency block.Data type: String\n\n
\n\nsubtotal\\_recurring\\_price\n\n\n\nRecurring price subtotal of the cart.Data type: String\n\n
\n\nsubtotal\\_recurring\\_price\n\n\n\nRecurring price subtotal of the current frequency blockData type: String\n\n
\n\ntotal\\_title\n\n\n\nTitle for total field on page.Data type: String\n\n
\n\ntotal\\_title\n\n\n\nTitle for total field on the current frequency block.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\\\"items\\\":[{\n \\\"sys_id\\\":\\\"04b7e94b4f7b4200086eeed18110c7fd\\\",\n \\\"variables\\\":{\n \\\"acrobat\\\":\\\"true\\\",\n \\\"Additional_software_requirements\\\":\\\"MS Office 2007\\\"\n },\n \\\"sysparm_quantity\\\":\\\"3\\\"\n},\n{\n \\\"sys_id\\\":\\\"e1be6dcb4f7b4200086eeed18110c74c\\\"\n},\n{\n \\\"sys_id\\\":\\\"186d917a6fab7980575967ddbb3ee4f2\\\",\n \\\"variables\\\":{\n \\\"new_email\\\":\\\"abel.tuter@example.com\\\"\n }\n},\n{\n \\\"sys_id\\\":\\\"8b3ae7fedc1be1004ece5c08239e522b\\\"\n},\n{\n \\\"sys_id\\\":\\\"962967674ff38200086eeed18110c7e7\\\",\n \\\"variables\\\":{\n \\\"ergonomic_office\\\":\\\"Office chair should have lumbar support\\\"\n }\n}]}\" \\\n--user \"username\":\"password\"\n```\n\n```\n\n{\n \"result\": {\n \"cart_id\": \"0d8c7a32c3211200d68d3b0ac3d3aeba\",\n \"subtotal_price\": \"$3,350.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$300.00\",\n \"total_title\": \"Total\",\n \"monthly\": {\n \"subtotal_price\": \"$50.00\",\n \"subtotal_recurring_frequency\": \"Monthly\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"items\": [\n {\n \"catalog_item_id\": \"90af095bcd38798071a208d710d1b64f\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"localized_price\": \"$50.00\",\n \"price\": \"$50.00\",\n \"recurring_frequency\": \"Monthly\",\n \"localized_recurring_price\": \"$0.00\",\n \"recurring_price\": \"$0.00\",\n \"item_name\": \"Belkin iPad Mini Case\",\n \"cart_item_id\": \"cb6e485fc3211200d68d3b0ac3d3ae35\",\n \"delivery_time\": \"2 Days\"\n }\n ],\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"none\": {\n \"subtotal_price\": \"-\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"items\": [\n {\n \"catalog_item_id\": \"186d917a6fab7980575967ddbb3ee4f2\",\n \"variables\": {\n \"Preferred Email address\": \"abel.tuter@example.com\"\n },\n \"quantity\": \"1\",\n \"localized_price\": \"$0.00\",\n \"price\": \"$0.00\",\n \"recurring_frequency\": \"\",\n \"localized_recurring_price\": \"$0.00\",\n \"recurring_price\": \"$0.00\",\n \"item_name\": \"New Email Account\",\n \"cart_item_id\": \"17c5241fc3211200d68d3b0ac3d3ae7f\",\n \"delivery_time\": \"global.Workflow\"\n },\n {\n \"catalog_item_id\": \"8b3ae7fedc1be1004ece5c08239e522b\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"localized_price\": \"$0.00\",\n \"price\": \"$0.00\",\n \"recurring_frequency\": \"\",\n \"localized_recurring_price\": \"$0.00\",\n \"recurring_price\": \"$0.00\",\n \"item_name\": \"Corp VPN\",\n \"cart_item_id\": \"97c5241fc3211200d68d3b0ac3d3ae7f\",\n \"delivery_time\": \"2 Days\"\n },\n {\n \"catalog_item_id\": \"e1be6dcb4f7b4200086eeed18110c74c\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"localized_price\": \"$0.00\",\n \"price\": \"$0.00\",\n \"recurring_frequency\": \"\",\n \"localized_recurring_price\": \"$0.00\",\n \"recurring_price\": \"$0.00\",\n \"item_name\": \"External Monitor\",\n \"cart_item_id\": \"d3c5241fc3211200d68d3b0ac3d3ae7f\",\n \"delivery_time\": \"2 Days\"\n },\n {\n \"catalog_item_id\": \"962967674ff38200086eeed18110c7e7\",\n \"variables\": {\n \"Please describe any ergonomic requirements\\n\\t\\t\": \"Office chair should have lumbar support\"\n },\n \"quantity\": \"1\",\n \"localized_price\": \"$0.00\",\n \"price\": \"$0.00\",\n \"recurring_frequency\": \"\",\n \"localized_recurring_price\": \"$0.00\",\n \"recurring_price\": \"$0.00\",\n \"item_name\": \"Desk Set Up\",\n \"cart_item_id\": \"d7c5241fc3211200d68d3b0ac3d3ae7f\",\n \"delivery_time\": \"5 Days\"\n }\n ],\n \"show_subtotal_price\": \"false\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"yearly\": {\n \"subtotal_price\": \"$3,300.00\",\n \"subtotal_recurring_frequency\": \"Annually\",\n \"subtotal_recurring_price\": \"$300.00\",\n \"total_title\": \"Total\",\n \"items\": [\n {\n \"catalog_item_id\": \"04b7e94b4f7b4200086eeed18110c7fd\",\n \"variables\": {\n \"Adobe Photoshop\": \"\",\n \"Adobe Acrobat\": \"true\",\n \"Optional Software\": \"\",\n \"Additional software requirements\": \"MS Office 2007\"\n },\n \"quantity\": \"3\",\n \"localized_price\": \"$1,100.00\",\n \"price\": \"$1,100.00\",\n \"recurring_frequency\": \"Annually\",\n \"localized_recurring_price\": \"$100.00\",\n \"recurring_price\": \"$100.00\",\n \"item_name\": \"Standard Laptop\",\n \"cart_item_id\": \"9fc5241fc3211200d68d3b0ac3d3ae7e\",\n \"delivery_time\": \"5 Days\"\n }\n ],\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n }\n}\n\nCase-2: if two-step is true:\n{\n \"result\": {\n \"request_number\": \"REQ0010001\",\n \"request_id\": \"82a7e89fc3211200d68d3b0ac3d3ae0a\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{item\\_sys\\_id\\}/get\\_invalid\\_delegated\\_users\n\nReturns a list of users whose request for the specified item cannot be delegated \\(requested by another user\\).\n\nYou can call this endpoint prior to calling an endpoint such as [Service Catalog API - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/add\\_to\\_cart](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/c_ServiceCatalogAPI.md) or [Service Catalog API - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/order\\_now](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/c_ServiceCatalogAPI.md) that allow the requisition of a service catalog item on behalf of another person. These calls fail if you pass in a user that is not authorized for the associated item. This endpoint allows you to verify your list of users prior to calling an endpoint that orders the item or tries to add the item to a cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nitem\\_sys\\_id\n\n\n\nSys\\_id of the service catalog item to verify whether the specified user has acquisition rights.Data type: String\n\nTable: Service Catalog \\[sc\\_catalog\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_also\\_request\\_for\n\n\n\nComma separated string of valid user sys\\_ids. The endpoint verifies that these users have acquisition rights to the specified service catalog item.Data type: String\n\nTable: Users \\[sys\\_users\\]\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Request failed. Bad request given for processing. Refer to the message in the return results for additional information on the error.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nerrCode\n\n\n\nNumber associated with the error. Only returned if the endpoint fails.Data type: String\n\n
\n\nerrMsg\n\n\n\nDescription of the error that the endpoint encountered when it failed.\n\n
\n\ninvalidUsers\n\n\n\nNames of the users that are not able to request the specified catalog item.Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\\\"sysparm_also_request_for\\\":\\\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\\\"}\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"invalidUsers\": [\n \"Abel Tuter\"\n ]\n }\n}\n```\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\\\"sysparm_also_request_for\\\":\\\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\\\"}\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"errCode\": \"42202\",\n \"errMsg\": \"This item cannot be submitted for multiple people as it is not configured with Requested For\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/order\\_now\n\nOrders the specified catalog item.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}/order_now`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the service catalog item.Data type: String\n\nTable: Catalog Item \\[sc\\_cat\\_item\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_also\\_request\\_for\n\n\n\nComma-separated string of user sys\\_ids of other users for which to order the specified item.- You cannot specify more than 50 additional users to receive the item.\n- If any person in the list doesn't qualify for the item, the entire request is rejected.\n- If the associated item does not have the **requested\\_for** variable set, the request is rejected.\n- If the associated item has the **requested\\_for** variable set, but the **Enable also Request for** variable is not configured, or the calling user doesn’t have the proper roles, the request is rejected.\n\nTable: User \\[sys\\_user\\]\n\n
\n\nsysparm\\_quantity\n\n\n\nRequired. Quantity of the item. Cannot be a negative number.Data type: Number\n\n
\n\nsysparm\\_requested\\_for\n\n\n\nSys\\_id of the user for whom to order the specified item.The settings of the **glide.sc.req\\_for.roles** and **glide.sc.req\\_for.roles.default** properties determine the level at which a user can request items.\n\n- If a value is specified in the **glide.sc.req\\_for.roles** property, the system checks if the user has the specified role to request information of other users.\n- If the **glide.sc.req\\_for.roles** property value is empty and the **glide.sc.req\\_for.roles.default** property value is `deny`, no user can request items for other users.\n- If the **glide.sc.req\\_for.roles** property value is empty and the **glide.sc.req\\_for.roles.default** property value is `allow`, any user can request items for other users.\n\nData type: String\n\n
\n\nvariables\n\n\n\nName-value pairs of all mandatory cart item variables. Mandatory variables are defined on the associated form.Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Indicates that the quantity value is invalid and the request is not placed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nnumber\n\n\n\nNumber of the generated request.Data type: String\n\n
\n\nparent\\_id\n\n\n\nIf available, the sys\\_id of the parent record from which the request is created. For more information, see [Configure a parent mapping for a request](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/configure-mapping-for-request.md).Data type: String\n\n
\n\nparent\\_table\n\n\n\nIf available, the name of the parent table from which the request is created.Data type: String\n\n
\n\nrequest\\_id\n\n\n\nSys\\_id of the order request.Data type: String\n\n
\n\nrequest\\_number\n\n\n\nRequest number.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the order.Data type: String\n\n
\n\ntable\n\n\n\nTable name of the request.Data type: String\n\n
### Sample cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\n sysparm_quantity: 1,\n variables: {\n replacement: 'Yes',\n originalnumber: '1640000',\n data_plan: '500MB'\n }\n}\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"sys_id\": \"cf56a3fcdb3a2300e890f71fbf9619ac\",\n \"number\": \"REQ0010012\",\n \"request_number\": \"REQ0010012\",\n \"request_id\": \"cf56a3fcdb3a2300e890f71fbf9619ac\",\n \"table\": \"sc_request\"\n }\n}\n```\n\n## Service Catalog - POST /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/submit\\_producer\n\nCreates a record and returns the Table API relative path and redirect URL to access the created record.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}/submit_producer`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the table in which to create the record producer.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_view\n\n\n\nUI view for which to render the data. Determines the fields returned in the response.Valid values:\n\n- desktop\n- mobile\n- both\n\nIf you also specify the **sysparm\\_fields** parameter, it takes precedent.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|variables|Name-value pairs of the variables of the producer record to define.|\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Indicates successful request and returns the response object consisting of Table API and URL to access the created record.|\n|400|Request is not processed due to incorrect request message.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Requested resource cannot be found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nnumber\n\n\n\nNumber of the ticket associated with the record producer.Data type: String\n\n
\n\nparent\\_id\n\n\n\nIf available, sys\\_id of the parent record from which the request is created. For more information, see [Configure a parent mapping for a request](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/configure-mapping-for-request.md).Data type: String\n\n
\n\nparent\\_table\n\n\n\nName of the parent table.Data type: String\n\n
\n\nrecord\n\n\n\nTable API relative path of the newly created record producer.Data type: String\n\n
\n\nredirect\\_portal\\_url\n\n\n\nURL to which to redirect the Service Portal.Data type: String\n\n
\n\nredirect\\_to\n\n\n\nRedirect value.Data type: String\n\n
\n\nredirect\\_url\n\n\n\nRedirect URL to access the created record producer.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the record created.Data type: String\n\n
\n\ntable\n\n\n\nName of the table on which the request was made.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{'variables':{'urgency':'2','comments':'This is sample incident'}}\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"sys_id\": \"6baf4e1ddbba2300e890f71fbf961963\",\n \"number\": \"INC0010006\",\n \"parent_id\": null,\n \"record\": \"api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963\",\n \"redirect_portal_url\": \"\",\n \"parent_table\": \"task\",\n \"redirect_url\": \"incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess\",\n \"table\": \"incident\",\n \"redirect_to\": \"\"\n }\n}\n```\n\n## Service Catalog - POST /sn/sc/servicecatalog/variables/\\{sys\\_id\\}/display\\_value\n\nReturns the display value of the specified variable.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value`\n\nDefault URL: `/api/sn_sc/servicecatalog/variables/{sys_id}/display_value`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the variable for which to return the display value.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_value\n\n\n\nSys\\_id of the record that contains the display value to return.Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not found. The requested item wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nDisplay value of the variable.Data type: String\n\n
### cURL request\n\n```\n\n curl \"https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value\" \\ \n--request POST \\ \n--header \"Accept:application/json\" \\ \n--header \"Content-Type:application/json\" \\ \n--data \"{\\\"sysparm_value\\\":\\\"62826bf03710200044e0bfc8bcbe5df1\\\"}\" \\ \n--user \"username\":\"password\" \n```\n\n```\n{\n \"result\": \"Abel Tuter (Architect)\"\n}\n```\n\n## Service Catalog - PUT /sn\\_sc/servicecatalog/cart/\\{cart\\_item\\_id\\}\n\nUpdates the specified item in the logged in user's cart.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}`\n\nDefault URL: `/api/sn_sc/servicecatalog/cart/{cart_item_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\ncart\\_item\\_id\n\n\n\nSys\\_id of the cart item to update.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nsysparm\\_quantity\n\n\n\nRequired. Quantity of the item to update the cart.Data type: String\n\n
\n\nvariables\n\n\n\nRequired if there are mandatory variables specified for the item. Object consisting of all mandatory variable names-value pairs.Data type: Object\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n201\n\n\n\nIndicates that the request completed successfully and that the item is added to the cart.\n\n
\n\n400\n\n\n\nFollowing three errors can occur:- Invalid quantity value:Indicates that either the sysparm\\_quantity parameter is not provided or contains invalid value.\n- Security constraints prevent ordering of Item:Indicates that either the item ID specified in the path parameters is either invalid or the user does not have access to the item.\n- Mandatory Variables are required:Indicates that one or more of the mandatory variable values is not provided in the request.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncart\\_id\n\n\n\nSys\\_id of the cart.Data type: String\n\n
\n\n<recurring\\_frequency>\n\n\n\nDescribes an items in the cart having a specific recurring frequency. Possible values include:\n\n- daily\n- monthly\n- yearly\n- none \\(no recurring fees\\)\n\n Data type: Object\n\n ```\n\"\": {\n \"frequency_label\": \"String\",\n \"items\": [Array],\n \"show_subtotal_price\": \"String\",\n \"subtotal_price\": \"String\",\n \"subtotal_recurring_frequency\": \"String\",\n \"subtotal_recurring_price\": \"String\",\n \"subtotal_title\": \"String\",\n \"total_title\": \"String\"\n}\n```\n\n
\n\n<recurring\\_frequency>.frequency\\_label\n\n\n\nFrequency of the associated recurring fee. If there are no recurring fees for the item, this parameter contains \"null\".Data type: String\n\n
\n\n<recurring\\_frequency>.items\n\n\n\nList of objects that describe each item associated with the specified recurring frequency category.Data type: Array\n\n ```\n\"items\": [{\n \"cart_item_id\": \"String\",\n \"catalog_item_id\": \"String\",\n \"created.by\": \"String\",\n \"created_on\": \"String\",\n \"delivery_time\": \"String\",\n \"item_id\": \"String\",\n \"item_name\": \"String\",\n \"localized_price\": \"String\",\n \"localized_recurring_price\": \"String\",\n \"name\": \"String\",\n \"order_guide\": \"String\",\n \"picture\": \"String\",\n \"price\": \"String\",\n \"quantity\": \"String\",\n \"recurring_frequency\": \"String\",\n \"recurring_price\": \"String\",\n \"recurring_subtotal\": Number,\n \"recurring_subtotal_price\": \"String\",\n \"short_description\": \"String\",\n \"show_price\": Boolean,\n \"show_quantity\": Boolean,\n \"show_recurring_price\": Boolean,\n \"subtotal\": Number,\n \"subtotal_price\": \"String\",\n \"sys_class_name\": \"String\",\n \"sys_id\": \"String\",\n \"updated_by\": \"String\",\n \"updated_on\": \"String\",\n \"variables\": {Object}\n}]\n```\n\n
\n\n<recurring\\_frequency>.items.cart\\_item\\_id\n\n\n\nSys\\_id of the item in this cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.catalog\\_item\\_id\n\n\n\nCatalog sys\\_id of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created.by\n\n\n\nUser that initially placed the item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.created\\_on\n\n\n\nDate on which the item was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.delivery\\_time\n\n\n\nTime that the specified item takes to be delivered.Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_id\n\n\n\nItem sys\\_id.Data type: String\n\n
\n\n<recurring\\_frequency>.items.item\\_name\n\n\n\nName of the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_price\n\n\n\nPrice of the item \\(in local currency\\).Data type: String\n\n
\n\n<recurring\\_frequency>.items.localized\\_recurring\\_price\n\n\n\nRecurring fee for the specified item \\(in local currency\\).Data type: String\n\n
\n\n<recurring\\_frequency>.items.name\n\n\n\nItem name.Data type: String\n\n
\n\n<recurring\\_frequency>.items.order\\_guide\n\n\n\nName of the order guide to which this item is associated. If this item is not associated with an order guide this parameter contains an empty string.Data type: String\n\n
\n\n<recurring\\_frequency>.items.picture\n\n\n\nFile name of the picture of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.price\n\n\n\nPrice of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.quantity\n\n\n\nNumber of the specified item in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_frequency\n\n\n\nHow often the recurring fee is charged for the specified item.Data type: String\n\n Default: Null\n\n
\n\n<recurring\\_frequency>.items.recurring\\_price\n\n\n\nRecurring fee for the specified item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\n\n\n\nSubtotal of the recurring fees for the item \\(**recurring\\_price** x **quantity**\\).Data type: Number\n\n
\n\n<recurring\\_frequency>.items.recurring\\_subtotal\\_price\n\n\n\nSubtotal of the recurring fees for the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.short\\_description\n\n\n\nShort description of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.show\\_price\n\n\n\nFlag that indicates whether the price of the item is shown in the cart.Possible values:\n\n- true: Show the price of the item in the cart.\n- false: Do not show the price of the item in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show.quantity\n\n\n\nFlag that indicates whether to show the item quantity in the cart.Possible values:\n\n- true: Show the item quantity in the cart.\n- false: Do not show the item quantity in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.show\\_recurring\\_price\n\n\n\nFlag that indicates whether the recurring fees should appear in the cart.Possible values:\n\n- true: Show the recurring fees in the cart.\n- false: Do not show the recurring fees in the cart.\n\n Data type: Boolean\n\n
\n\n<recurring\\_frequency>.items.subtotal\n\n\n\nSubtotal of the number of items.Data type: Number\n\n
\n\n<recurring\\_frequency>.items.subtotal\\_price\n\n\n\nSubtotal for the item \\(**price** x **quantity**\\).Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_class\\_name\n\n\n\nSystem classification name of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.sys\\_id\n\n\n\nSys\\_id of the item.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_by\n\n\n\nUser that updated the item after it was initially placed in the cart.Data type: String\n\n
\n\n<recurring\\_frequency>.items.updated\\_on\n\n\n\nLast date/time on which the item was either initially placed in the cart or updated.Data type: String\n\n
\n\n<recurring\\_frequency>.items.variables\n\n\n\nName-value pairs of the item variables.Data type: Object\n\n
\n\n<recurring\\_frequency>.show\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show a subtotal for the associated recurring fee category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_price\n\n\n\nSubtotal of the cost of all items for the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring fees of the items within the associated recurring frequency category.Data type: String\n\n
\n\n<recurring\\_frequency>.subtotal\\_title\n\n\n\nIf the **show\\_subtotal\\_price** is set to `true`, the text to display in the cart for the associated subtitle.Data type: String\n\n
\n\n<recurring\\_frequency>.total\\_title\n\n\n\nText to display for the total title for the associated recurring frequency category.Data type: String\n\n
\n\nshow\\_subtotal\\_price\n\n\n\nFlag that indicates whether to show the subtotal price in the cart.Possible values:\n\n- true: Show subtotals in the cart.\n- false: Do not show subtotals in the cart.\n\n Data type: String\n\n
\n\nsubtotal\\_price\n\n\n\nSubtotal of all items in the cart.Data type: String\n\n
\n\nsubtotal\\_recurring\\_frequency\n\n\n\nType of subtotal recurring frequency, such as daily, monthly, etc. Same as **<recurring\\_frequency>.subtotal\\_recurring\\_frequency**.Data type: String\n\n
\n\nsubtotal\\_recurring\\_price\n\n\n\nSubtotal of the recurring frequency fees for all items in the cart.Data type: String\n\n
\n\nsubtotal\\_title\n\n\n\nText to display in the cart for the subtotal field title.Data type: String\n\n
\n\ntotal\\_title\n\n\n\nText to display in the cart for the total field title.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065\" \\\n--request PUT \\\n--header \"Accept:application/json\" \\\n--data \"{\\\"sysparm_quantity\\\": \\\"2\\\" }\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"cart_id\": \"0830db8413a56300397533e2e144b0ba\",\n \"subtotal_price\": \"$2,397.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"none\": {\n \"subtotal_price\": \"$2,397.00\",\n \"subtotal_recurring_frequency\": \"\",\n \"subtotal_recurring_price\": \"$0.00\",\n \"total_title\": \"Total\",\n \"frequency_label\": null,\n \"items\": [\n {\n \"updated_on\": \"2018-11-06 17:01:21\",\n \"catalog_item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"short_description\": \"Apple iPhone 7 \",\n \"recurring_subtotal_price\": \"$0.00\",\n \"delivery_time\": \"2 Days\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"a846872a1369e300027879d96144b07e\",\n \"price\": \"$799.00\",\n \"recurring_frequency\": null,\n \"subtotal_price\": \"$799.00\",\n \"variables\": {},\n \"quantity\": \"1\",\n \"item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"recurring_price\": \"$0.00\",\n \"show_price\": true,\n \"item_name\": \"Apple iPhone7\",\n \"cart_item_id\": \"a846872a1369e300027879d96144b07e\",\n \"recurring_subtotal\": 0,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"e823ee6b0bf00300eba42da0d5673a95.iix\",\n \"created_on\": \"2018-11-06 17:01:21\",\n \"localized_price\": \"$799.00\",\n \"subtotal\": 799,\n \"show_recurring_price\": false,\n \"name\": \"Apple iPhone7\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$0.00\",\n \"order_guide\": \"\"\n },\n {\n \"updated_on\": \"2018-11-06 17:21:08\",\n \"catalog_item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"short_description\": \"Apple iPhone 7 \",\n \"recurring_subtotal_price\": \"$0.00\",\n \"delivery_time\": \"2 Days\",\n \"sys_class_name\": \"sc_cat_item\",\n \"sys_id\": \"7d138fa21329e300027879d96144b065\",\n \"price\": \"$799.00\",\n \"recurring_frequency\": null,\n \"subtotal_price\": \"$1,598.00\",\n \"variables\": {},\n \"quantity\": \"2\",\n \"item_id\": \"07f1666b0bf00300eba42da0d5673ab0\",\n \"recurring_price\": \"$0.00\",\n \"show_price\": true,\n \"item_name\": \"Apple iPhone7\",\n \"cart_item_id\": \"7d138fa21329e300027879d96144b065\",\n \"recurring_subtotal\": 0,\n \"show_quantity\": true,\n \"created_by\": \"admin\",\n \"picture\": \"e823ee6b0bf00300eba42da0d5673a95.iix\",\n \"created_on\": \"2018-11-06 16:47:30\",\n \"localized_price\": \"$799.00\",\n \"subtotal\": 1598,\n \"show_recurring_price\": false,\n \"name\": \"Apple iPhone7\",\n \"updated_by\": \"admin\",\n \"localized_recurring_price\": \"$0.00\",\n \"order_guide\": \"\"\n }\n ],\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n },\n \"show_subtotal_price\": \"true\",\n \"subtotal_title\": \"Subtotal\"\n }\n}\n```\n\n## Service Catalog - PUT /sn\\_sc/servicecatalog/items/\\{sys\\_id\\}/submit\\_guide\n\nRetrieves a list of items based on the needs described for an order guide.\n\n### URL format\n\nVersioned URL: `/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide`\n\nDefault URL: `/api/sn_sc/servicecatalog/items/{sys_id}/submit_guide`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the order guide whose items are to be retrieved.Data type: String\n\nTable: Order guide \\[sc\\_cat\\_item\\_guide\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nvariables\n\n\n\nVariables requested for an item. Each variable is a JSON object consisting of name-value pairs. Data type: Array\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nIndicates that the request has completed successfully. Returns a list of items based on the passed-in variable list. If the result set does not contain any items, then an empty array is returned.\n\n
\n\n400\n\n\n\nIndicates that the request is invalid. Could be due to one of the following reasons:- User does not have access to the item.\n- Mandatory variables of one or more items have not been answered. \\(Only variables defined as mandatory are honored.\\)\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal error while calculating items depending on options chosen.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncatalogs\n\n\n\nList of objects to which the item belongs and each catalog title and sys\\_id of the catalog.Data type: Array of Objects\n\n```\n\"catalogs\": [\n {\n \"sys_id\": \"String\",\n \"title\": \"String\" \n }\n]\n```\n\n
\n\ncatalogs.sys\\_id\n\n\n\nSys\\_id of the catalog.Data type: String\n\n
\n\ncatalogs.title\n\n\n\nCatalog title.Data type: String\n\n
\n\ncategory\n\n\n\nCategory that contains this item.Data type: Object\n\n```\n\"catalogs\": {\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}\n```\n\n
\n\ncategory.sys\\_id\n\n\n\nSys\\_id of the category.Data type: String\n\n
\n\ncategory.title\n\n\n\nCategory titleData type: String\n\n
\n\nclient\\_script\n\n\n\nList of all the catalog client scripts defined on the catalog item.Data type: Object\n\n```\n\"client_script\": {\n \"onChange\": [Array],\n \"onLoad\": [Array],\n \"onSubmit\": [Array]\n}\n```\n\n
\n\nclient\\_script.onChange\n\n\n\nList of onChange client scripts associated with the item.Data type: Array\n\n
\n\nclient\\_script.onLoad\n\n\n\nList of onLoad client scripts associated with the item.Data type: Array\n\n
\n\nclient\\_script.onSubmit\n\n\n\nList of onSubmit client scripts associated with the item.Data type: Array\n\n
\n\ndata\\_lookup\n\n\n\nData lookups defined on the catalog item.Data type: Array\n\n
\n\ndescription\n\n\n\nFull description of catalog item.Data type: String\n\n
\n\nicon\n\n\n\nPath of the image that appears as an icon beside the catalog item.Data type: String\n\n
\n\nname\n\n\n\nName of the catalog item.Data type: String\n\n
\n\nshort\\_description\n\n\n\nText on the service catalog homepage or search results page, or the title on the order form of the catalog item.Data type: String\n\n
\n\nshow\\_price\n\n\n\nFlag that indicates whether to show the price details. If true, returns the following details. - local\\_currency\n- localized\\_price\n- localized\\_recurring\\_price\n- price\n- price\\_currency\n- recurring\\_frequency\n- recurring\\_price\n- recurring\\_price\\_currency\n\nData type: Boolean\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the catalog item.Data type: String\n\n
\n\ntype\n\n\n\nItem type. Possible values:\n\n- catalog item\n- order guide\n- record producer item\n\nData type: String\n\n
\n\nvariables\n\n\n\nName-value pairs of all the variables associated with the catalog item.Data type: Array\n\n
\n\nui\\_policy\n\n\n\nList of all catalog UI policies defined on the catalog item.Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide\" \\\n--request PUT \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\n \\\"variables\\\":{\n \\\"hiring_manager\\\":\\\"6816f79cc0a8016401c5a33be04be441\\\",\n \\\"hiring_group\\\":\\\"221f3db5c6112284009f4becd3039cc9\\\",\n \\\"remote\\\":\\\"No\\\",\n \\\"standard_package\\\":\\\"No\\\",\n \\\"laptop_type\\\":\\\"developer\\\"\n }\n}\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": [\n {\n \"short_description\": \"Lenovo - Carbon x1\",\n \"icon\": \"1195c2084f889200086eeed18110c74a.iix\",\n \"description\": \"

x1 Carbon

\\n

The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile.

\\n

Technical Specs:

\\n\",\n \"show_price\": true,\n \"recurring_price\": \"$100.00\",\n \"type\": \"catalog_item\",\n \"local_currency\": \"USD\",\n \"sys_id\": \"04b7e94b4f7b4200086eeed18110c7fd\",\n \"recurring_price_currency\": \"USD\",\n \"localized_price\": \"$1,100.00\",\n \"price\": \"$1,100.00\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"recurring_frequency\": \"Annually\",\n \"name\": \"Standard Laptop\",\n \"localized_recurring_price\": \"$100.00\",\n \"category\": {\n \"sys_id\": \"d258b953c611227a0146101fb1be7c31\",\n \"title\": \"Hardware\"\n },\n \"price_currency\": \"USD\",\n \"show_quantity\": false,\n \"quantity\": \"1\",\n \"order\": \"100\",\n \"variables\": [\n {\n \"label\": \"Optional Software\",\n \"type\": 0,\n \"mandatory\": false,\n \"displayvalue\": \"\",\n \"friendly_type\": \"container_start\",\n \"render_label\": true,\n \"read_only\": false,\n \"children\": [\n {\n \"label\": \"Adobe Acrobat\",\n \"type\": 7,\n \"mandatory\": false,\n \"displayvalue\": \"false\",\n \"friendly_type\": \"check_box\",\n \"display_type\": \"CheckBox\",\n \"render_label\": true,\n \"read_only\": false,\n \"pricing_implications\": false,\n \"name\": \"acrobat\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"90b72d4b4f7b4200086eeed18110c701\",\n \"value\": false,\n \"help_text\": \"\",\n \"max_length\": 0\n },\n {\n \"label\": \"Adobe Photoshop\",\n \"type\": 7,\n \"mandatory\": false,\n \"displayvalue\": \"false\",\n \"friendly_type\": \"check_box\",\n \"display_type\": \"CheckBox\",\n \"render_label\": true,\n \"read_only\": false,\n \"pricing_implications\": false,\n \"name\": \"photoshop\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"a8b72d4b4f7b4200086eeed18110c701\",\n \"value\": false,\n \"help_text\": \"\",\n \"max_length\": 0\n }\n ],\n \"name\": \"optional_label\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"10b72d4b4f7b4200086eeed18110c700\",\n \"value\": \"\",\n \"help_text\": \"\",\n \"max_length\": 0\n },\n {\n \"label\": \"Additional software requirements\",\n \"type\": 2,\n \"mandatory\": false,\n \"displayvalue\": \"\",\n \"friendly_type\": \"multi_line_text\",\n \"display_type\": \"Multi Line Text\",\n \"render_label\": true,\n \"read_only\": false,\n \"name\": \"Additional_software_requirements\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"a8b72d4b4f7b4200086eeed18110c702\",\n \"value\": \"\",\n \"help_text\": \"\",\n \"max_length\": 0\n }\n ],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n },\n {\n \"sys_id\": \"e1be6dcb4f7b4200086eeed18110c74c\",\n \"short_description\": \"LG IPS 27\\\" Monitor\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"External Monitor\",\n \"icon\": \"08569a4c4f889200086eeed18110c77b.iix\",\n \"description\": \"


The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor.

\\n

Item Specs:

\\n\",\n \"show_price\": false,\n \"type\": \"catalog_item\",\n \"category\": {\n \"sys_id\": \"2c0b59874f7b4200086eeed18110c71f\",\n \"title\": \"Peripherals\"\n },\n \"show_quantity\": false,\n \"quantity\": \"1\",\n \"order\": \"200\",\n \"variables\": [],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n },\n {\n \"sys_id\": \"186d917a6fab7980575967ddbb3ee4f2\",\n \"short_description\": \"New Email Creation\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"New Email Account\",\n \"icon\": \"b630e97e6fab7980575967ddbb3ee4d2.iix\",\n \"description\": \"

Service Overview:

\\n\\t

Creation of a new email account within our Microsoft Exchange environment. Creation of your email address will also create your Active Directory account.

\\n\\t

\",\n \"show_price\": false,\n \"type\": \"catalog_item\",\n \"category\": {\n \"sys_id\": \"109f0438c6112276003ae8ac13e7009d\",\n \"title\": \"Services\"\n },\n \"show_quantity\": false,\n \"quantity\": \"1\",\n \"order\": \"300\",\n \"variables\": [\n {\n \"label\": \"Preferred Email address\",\n \"type\": 6,\n \"mandatory\": true,\n \"displayvalue\": \"\",\n \"friendly_type\": \"single_line_text\",\n \"display_type\": \"Single Line Text\",\n \"render_label\": true,\n \"read_only\": false,\n \"name\": \"new_email\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"65865e474fbb4200086eeed18110c7dd\",\n \"value\": \"\",\n \"help_text\": \"\",\n \"max_length\": 0\n }\n ],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n },\n {\n \"sys_id\": \"8b3ae7fedc1be1004ece5c08239e522b\",\n \"short_description\": \"Remote access to Internal Corporate Systems\\n\\t\\t\",\n \"catalogs\": [\n {\n \"sys_id\": \"e0d08b13c3330100c8b837659bba8fb4\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"Corp VPN\",\n \"icon\": \"11dc8df74f778200086eeed18110c78e.iix\",\n \"description\": \"

Corp VPN Account

\\n\\n

\\n

Please reference the CORP VPN Installation and Support Documentation for instructions on installation, usage and FAQ’s. For all other questions, please contact IT Support.

\\n

\\n



\",\n \"show_price\": false,\n \"type\": \"catalog_item\",\n \"category\": {\n \"sys_id\": \"d2f7cae4c611227a018ddc481b34e099\",\n \"title\": \"Security and Access\"\n },\n \"show_quantity\": false,\n \"quantity\": \"1\",\n \"order\": \"600\",\n \"variables\": [],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n },\n {\n \"sys_id\": \"962967674ff38200086eeed18110c7e7\",\n \"short_description\": \"Desk Set Up for New Hires or Employee Moves\\n\\t\\t\",\n \"catalogs\": [\n {\n \"sys_id\": \"\",\n \"title\": \"Service Catalog\"\n }\n ],\n \"name\": \"Desk Set Up\",\n \"icon\": \"aa6b08ff4ff38200086eeed18110c7ed.iix\",\n \"description\": \"

The facilities organization will set up your new desk with the following configuration:

\\n\",\n \"show_price\": false,\n \"type\": \"catalog_item\",\n \"category\": {\n \"sys_id\": \"\",\n \"title\": null\n },\n \"show_quantity\": false,\n \"quantity\": \"1\",\n \"order\": \"900\",\n \"variables\": [\n {\n \"label\": \"Please describe any ergonomic requirements\\n\\t\\t\",\n \"type\": 2,\n \"mandatory\": false,\n \"displayvalue\": \"\",\n \"friendly_type\": \"multi_line_text\",\n \"display_type\": \"Multi Line Text\",\n \"render_label\": true,\n \"read_only\": false,\n \"name\": \"ergonomic_office\",\n \"attributes\": \"edge_encryption_enabled=true\",\n \"id\": \"b0b9ab674ff38200086eeed18110c755\",\n \"value\": \"\",\n \"help_text\": \"\",\n \"max_length\": 0\n }\n ],\n \"ui_policy\": [],\n \"client_script\": {\n \"onChange\": [],\n \"onSubmit\": [],\n \"onLoad\": []\n },\n \"data_lookup\": []\n }\n ]\n}\n\n```\n\n"}}