Delete order custom attributeBeta

DELETE

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

Deletes a custom attribute associated with a customer profile.

To delete a custom attribute owned by another application, the visibility setting must be 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_WRITE

Guide

Delete 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 delete. This key must match the key of an existing custom attribute definition.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.