Retrieve order custom attributeBeta

GET

/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}

Retrieves a custom attribute associated with an order.

You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call.

To retrieve a custom attribute owned 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

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

order_id

string

Required

The ID of the target order.

Link to section

custom_attribute_key

string

Required

The key of the custom attribute to retrieve. This key must match the key of an existing custom attribute definition.

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

with_definition

boolean

Indicates whether to return the custom attribute definition in the definition field of each custom attribute. Set this parameter to true to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is false.

Link to section

Response fields

Link to section

custom_attribute

The retrieved custom attribute. If with_definition was set to true in the request, the custom attribute definition is returned in the `definition field.

Link to section

errors

Any errors that occurred during the request.