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

{
  "name": "RetrieveOrderCustomAttribute",
  "fully_qualified_name": "SquareupApi.RetrieveOrderCustomAttribute@2.0.0",
  "description": "Retrieve a custom attribute for a specified order.\n\nUse this tool to get a custom attribute linked to an order. It can also retrieve the custom attribute definition if needed. Visibility settings determine if attributes from other applications can be accessed.",
  "toolkit": {
    "name": "ArcadeSquareupApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "order_id",
        "required": true,
        "description": "The unique 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 the custom attribute to retrieve, matching an existing attribute 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": "custom_attribute_version",
        "required": false,
        "description": "Specify the current version of the custom attribute for optimistic concurrency control.",
        "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 custom attribute definition details such as name, description, and data type. Defaults to 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`."
        },
        "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.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/{order_id}/custom-attributes/{custom_attribute_key}",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "version",
        "tool_parameter_name": "custom_attribute_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,
        "default": null,
        "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,
        "default": 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,
        "default": null,
        "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,
        "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": null,
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}