{ "name": "BulkDeleteOrderCustomAttributes", "fully_qualified_name": "SquareupApi.BulkDeleteOrderCustomAttributes@2.0.0", "description": "Perform bulk deletion of custom attributes from orders.\n\nUse this tool to delete multiple custom attributes from one or more orders in bulk. It processes a map of delete requests and returns a map of responses, each paired with a request ID.", "toolkit": { "name": "ArcadeSquareupApi", "description": null, "version": "2.0.0" }, "input": { "parameters": [ { "name": "delete_requests_map", "required": true, "description": "A JSON object with up to 25 delete requests, each including an order ID and custom attribute details.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "values": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A map of requests that correspond to individual delete operations for custom attributes." } }, "inner_properties": null, "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details." }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'BulkDeleteOrderCustomAttributes'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-squareup", "provider_type": "oauth2", "id": null, "oauth2": { "scopes": [ "ORDERS_WRITE" ] } }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the squareup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://connect.squareup.com/v2/orders/custom-attributes/bulk-delete", "http_method": "POST", "headers": {}, "parameters": [ { "name": "requestBody", "tool_parameter_name": "delete_requests_map", "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "values": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A map of requests that correspond to individual delete operations for custom attributes." } }, "inner_properties": null, "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details." }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Represents a bulk delete request for one or more order custom attributes.\",\n \"x-release-status\": \"BETA\",\n \"required\": [\n \"values\"\n ],\n \"properties\": {\n \"values\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"object\",\n \"description\": \"Represents one delete within the bulk operation.\",\n \"x-release-status\": \"BETA\",\n \"required\": [\n \"order_id\"\n ],\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"description\": \"The key of the custom attribute to delete. This key must match the key \\nof an existing custom attribute definition.\",\n \"minLength\": 1,\n \"pattern\": \"^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$\",\n \"readOnly\": true\n },\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the target [order](entity:Order).\",\n \"minLength\": 1,\n \"maxLength\": 255\n }\n }\n },\n \"description\": \"A map of requests that correspond to individual delete operations for custom attributes.\"\n }\n },\n \"example\": {\n \"values\": {\n \"cover-count\": {\n \"key\": \"cover-count\",\n \"order_id\": \"7BbXGEIWNldxAzrtGf9GPVZTwZ4F\"\n },\n \"table-number\": {\n \"key\": \"table-number\",\n \"order_id\": \"7BbXGEIWNldxAzrtGf9GPVZTwZ4F\"\n }\n }\n }\n }\n }\n }\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }