v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

OrderCustomAttributes

ListOrderCustomAttributes

Lists the custom attributes associated with an order.

You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call.

When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

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

Path parameters

order_idstring required

The ID of the target order.

Query parameters

visibility_filter'ALL' | 'READ' | 'READ_WRITE'

Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.

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

cursorstring

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.

limitinteger

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.

with_definitionsboolean

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.

Response

Success

cursorstring

The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see Pagination.

Example response

{
  "custom_attributes": [
    {
      "created_at": "2022-11-10T17:31:36.111Z",
      "key": "wayne-test-15",
      "updated_at": "2022-11-10T17:31:36.111Z",
      "value": "TEST",
      "version": 1,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  ]
}