OrderCustomAttributes
RetrieveOrderCustomAttributeDefinition
Retrieves an order-related custom attribute definition from a Square seller account.
To retrieve a custom attribute definition created by another application, the visibility setting must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Note that seller-defined custom attributes (also known as custom fields) are always set to VISIBILITY_READ_WRITE_VALUES.
get/v2/orders/custom-attribute-definitions/{key}
Path parameters
keystring required
The key of the custom attribute definition to retrieve.
Query parameters
versioninteger
To enable optimistic concurrency control, include this optional field and specify the current version of the custom attribute.
Response
Success
Example response
{
"custom_attribute_definition": {
"created_at": "2022-10-06T16:53:23.141Z",
"description": "The number of people seated at a table",
"key": "cover-count",
"name": "Cover count",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number"
},
"updated_at": "2022-10-06T16:53:23.141Z",
"version": 1,
"visibility": "VISIBILITY_READ_WRITE_VALUES"
}
}