List order custom attribute definitions

Beta

- GET /v2/orders/custom-attribute-definitions

Lists the order-related custom attribute definitions that belong to a Square seller account.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Parameters

visibility_filter

Requests that all of the custom attributes be returned, or only those that are read-only or read-write.

string

Select visibility_filter

ALL All custom attributes or custom attribute definitions.
READ All custom attributes or custom attribute definitions with the visibility field set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
READ_WRITE All custom attributes or custom attribute definitions with the visibility field set to VISIBILITY_READ_WRITE_VALUES.

cursor

The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

string

limit

The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see Pagination.

integer

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums