Retrieve order custom attribute definitionBeta

GET

/v2/orders/custom-attribute-definitions/{key}

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.

Permissions:ORDERS_READ

Guide

Retrieve an order custom attribute definition

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

key

string

Required

The key of the custom attribute definition to retrieve.

Link to section

Query parameters

Link to section

version

integer(32-bit)

To enable optimistic concurrency control, include this optional field and specify the current version of the custom attribute.

Link to section

Response fields

Link to section

custom_attribute_definition

The retrieved custom attribute definition.

Link to section

errors

Any errors that occurred during the request.