arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/RetrieveOrderCustomAttribute.json

{
  "name": "RetrieveOrderCustomAttribute",
  "fully_qualified_name": "SquareupApi.RetrieveOrderCustomAttribute@0.1.0",
  "description": "Retrieve a custom attribute associated with an order.\n\nThis tool retrieves a custom attribute linked to a specified order. It can also return the custom attribute definition if requested. Use this when you need information about custom fields attached to an order, especially those with specific visibility settings.",
  "toolkit": {
    "name": "ArcadeSquareupApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "order_id",
        "required": true,
        "description": "The ID of the target order to retrieve the custom attribute for.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the target [order](entity:Order)."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "order_id"
      },
      {
        "name": "custom_attribute_key",
        "required": true,
        "description": "The key for retrieving the custom attribute associated with the order. Must match an existing definition key.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The key of the custom attribute to retrieve.  This key must match the key of an\nexisting custom attribute definition."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_key"
      },
      {
        "name": "current_version",
        "required": false,
        "description": "Specify the current version of the custom attribute for optimistic concurrency control. This is an optional integer value.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "version"
      },
      {
        "name": "include_custom_attribute_definition",
        "required": false,
        "description": "Set to true to include the custom attribute definition details in the response, such as name, description, and data type.",
        "value_schema": {
          "val_type": "boolean",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "with_definition"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'RetrieveOrderCustomAttribute'.",
    "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_READ"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the squareup API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.0.0",
      "description": ""
    },
    "url": "https://connect.squareup.com/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "version",
        "tool_parameter_name": "current_version",
        "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "with_definition",
        "tool_parameter_name": "include_custom_attribute_definition",
        "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.",
        "value_schema": {
          "val_type": "boolean",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "order_id",
        "tool_parameter_name": "order_id",
        "description": "The ID of the target [order](entity:Order).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the target [order](entity:Order)."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_key",
        "tool_parameter_name": "custom_attribute_key",
        "description": "The key of the custom attribute to retrieve.  This key must match the key of an\nexisting custom attribute definition.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The key of the custom attribute to retrieve.  This key must match the key of an\nexisting custom attribute definition."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "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
      }
    ]
  }
}