Square

Square OrderCustomAttributes API

The OrderCustomAttributes API from Square — 6 operation(s) for ordercustomattributes.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/orders/custom-attribute-definitions List order custom field definitions · Square List Order Custom Attribute Definitions #

Ask an LLM

“What custom fields have been defined for orders?”

“Can I filter order custom attribute definitions by visibility?”

Tell an agent

List all order custom attribute definitions.

Show order custom field definitions with visibility {visibility_filter}.

POST /v2/orders/custom-attribute-definitions Define a new custom field for orders · Square Create Order Custom Attribute Definition #

Ask an LLM

“How do I add a custom field, like a delivery note, to orders?”

“Can I define my own attribute that can be set on any order?”

Tell an agent

Create order custom attribute definition {custom_attribute_definition}.

Define a new custom field for orders: {custom_attribute_definition}.

DELETE /v2/orders/custom-attribute-definitions/{key} Delete an order custom field definition · Square Delete Order Custom Attribute Definition #

Ask an LLM

“How do I remove a custom field definition from orders entirely?”

“Who is allowed to delete an order custom attribute definition?”

Tell an agent destructive · confirm first

Delete order custom attribute definition {key}.

Remove the order custom field {key} from my account.

GET /v2/orders/custom-attribute-definitions/{key} Get an order custom field definition · Square Retrieve Order Custom Attribute Definition #

Ask an LLM

“What does one order custom attribute definition contain?”

“Can I read a specific version of an order custom field definition?”

Tell an agent

Get the order custom attribute definition {key}.

Show version {version} of order custom field definition {key}.

PUT /v2/orders/custom-attribute-definitions/{key} Update an order custom field definition · Square Update Order Custom Attribute Definition #

Ask an LLM

“How do I change the name or description of an order custom field?”

“Can only the owner update an order custom attribute definition?”

Tell an agent

Update order custom attribute definition {key} with {custom_attribute_definition}.

Change the definition of order custom field {key}.

POST /v2/orders/custom-attributes/bulk-delete Delete custom field values on many orders · Square Bulk Delete Order Custom Attributes #

Ask an LLM

“Can I clear custom field values from several orders at once?”

“Is there a bulk delete for order custom attributes?”

Tell an agent destructive · confirm first

Bulk delete these order custom attributes: {values}.

Remove custom field values from multiple orders: {values}.

POST /v2/orders/custom-attributes/bulk-upsert Set custom field values on many orders · Square Bulk Upsert Order Custom Attributes #

Ask an LLM

“How do I set a custom field value on lots of orders in one call?”

“Can I bulk create or update order custom attributes?”

Tell an agent

Bulk upsert order custom attributes {values}.

Set these custom field values across several orders: {values}.

GET /v2/orders/{order_id}/custom-attributes List an order's custom field values · Square List Order Custom Attributes #

Ask an LLM

“What custom field values are stored on a specific order?”

“Can I get an order's custom attributes together with their definitions?”

Tell an agent

List custom attributes on order {order_id}.

Show custom field values for order {order_id} with definitions: {with_definitions}.

DELETE /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} Delete a custom field value from an order · Square Delete Order Custom Attribute #

Ask an LLM

“How do I clear one custom field value from a single order?”

“Can I remove an order's custom attribute without deleting its definition?”

Tell an agent destructive · confirm first

Delete custom attribute {custom_attribute_key} from order {order_id}.

Clear the {custom_attribute_key} field on order {order_id}.

GET /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} Get one custom field value on an order · Square Retrieve Order Custom Attribute #

Ask an LLM

“How do I read a single custom field value from an order?”

“Can I fetch one order custom attribute along with its definition?”

Tell an agent

Get custom attribute {custom_attribute_key} on order {order_id}.

Read the {custom_attribute_key} field value of order {order_id}.

POST /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} Set a custom field value on an order · Square Upsert Order Custom Attribute #

Ask an LLM

“How do I save a custom field value on one order?”

“Can I update an existing custom attribute on a single order?”

Tell an agent

Set custom attribute {custom_attribute_key} on order {order_id} to {custom_attribute}.

Upsert the {custom_attribute_key} field on order {order_id}.

Square OrderCustomAttributes API

Operations 11

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification