Square OrderCustomAttributes API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include OrderCustomAttributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
11 operations
across 6 paths,
and defines 25 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
11 operations6 paths25 schemas2 DELETE4 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Square OrderCustomAttributes API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes.
An API key is passed in the header as Authorization (oauth2ClientSecret).
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are CustomAttributeDefinition (8 properties), CustomAttribute (7 properties), Error (4 properties), ListOrderCustomAttributeDefinitionsResponse (3 properties). Each schema is shown below with its type and property counts.
CustomAttributeDefinition
object
Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom att…
8 properties
ListOrderCustomAttributeDefinitionsResponse
object
Represents a response from listing order custom attribute definitions.
3 properties1 required
CustomAttribute
object
A custom attribute value. Each custom attribute value has a corresponding CustomAttributeDefinition object.
7 properties
RetrieveOrderCustomAttributeDefinitionResponse
object
Represents a response from getting an order custom attribute definition.
2 properties
CustomAttributeDefinitionVisibility
string
The level of permission that a seller or other applications requires to view this custom attribute definition. The Visibility field controls who can read and w…
DeleteOrderCustomAttributeDefinitionResponse
object
Represents a response from deleting an order custom attribute definition.
1 property
BulkUpsertOrderCustomAttributesResponse
object
Represents a response from a bulk upsert of order custom attributes.
2 properties1 required
BulkUpsertOrderCustomAttributesRequest
object
Represents a bulk upsert request for one or more order custom attributes.
Represents an update request for an order custom attribute definition.
2 properties1 required
UpsertOrderCustomAttributeRequest
object
Represents an upsert request for an order custom attribute.
2 properties1 required
UpsertOrderCustomAttributeResponse
object
Represents a response from upserting order custom attribute definitions.
2 properties
RetrieveOrderCustomAttributeResponse
object
Represents a response from getting an order custom attribute.
2 properties
VisibilityFilter
string
Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.
DeleteOrderCustomAttributeResponse
object
Represents a response from deleting an order custom attribute.
1 property
UpdateOrderCustomAttributeDefinitionResponse
object
Represents a response from updating an order custom attribute definition.
2 properties
CreateOrderCustomAttributeDefinitionRequest
object
Represents a create request for an order custom attribute definition.
2 properties1 required
CreateOrderCustomAttributeDefinitionResponse
object
Represents a response from creating an order custom attribute definition.
2 properties
BulkDeleteOrderCustomAttributesRequest
object
Represents a bulk delete request for one or more order custom attributes.
1 property1 required
ListOrderCustomAttributesResponse
object
Represents a response from listing order custom attributes.
3 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
BulkDeleteOrderCustomAttributesResponse
object
Represents a response from deleting one or more order custom attributes.
2 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Square OrderCustomAttributes API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
