update-order-custom-attribute-definition-request.md

Update Order Custom Attribute Definition Request

Represents an update request for an order custom attribute definition.

Structure

UpdateOrderCustomAttributeDefinitionRequest

Fields

Name	Type	Tags	Description	Getter
CustomAttributeDefinition	CustomAttributeDefinition	Required	Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.	CustomAttributeDefinition getCustomAttributeDefinition()
IdempotencyKey	String	Optional	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 45	String getIdempotencyKey()

Example (as JSON)

{
  "custom_attribute_definition": {
    "key": "cover-count",
    "version": 1,
    "visibility": "VISIBILITY_READ_ONLY",
    "schema": {
      "key1": "val1",
      "key2": "val2"
    },
    "name": "name2",
    "description": "description8"
  },
  "idempotency_key": "IDEMPOTENCY_KEY"
}