Skip to main content

AttributeDescriptionDeleteFailure

No description

type AttributeDescriptionDeleteFailure {
  attributeDescriptionId: String!
  reason: AttributeDescriptionDeleteFailureReason!
  name: String
  attributeClass: String
  usage: AttributeDescriptionUsageBreakdown
}

Fields​

AttributeDescriptionDeleteFailure.attributeDescriptionId ● String! non-null scalar​

The id from the request that was not deleted.

AttributeDescriptionDeleteFailure.reason ● AttributeDescriptionDeleteFailureReason! non-null enum​

Why it was not deleted.

Only ATTRIBUTE_DESCRIPTION_USAGE_CHECK_FAILED is worth retrying: the other two describe a state that a repeat of the same request cannot change.

AttributeDescriptionDeleteFailure.name ● String scalar​

Name of the description. Null for ATTRIBUTE_DESCRIPTION_NOT_FOUND, where no row was read.

AttributeDescriptionDeleteFailure.attributeClass ● String scalar​

Class of the description, as the enum NAME (ORDER_ITEM, not orderItem).

Null for ATTRIBUTE_DESCRIPTION_NOT_FOUND. Typed as a string rather than the enum so that REST and GraphQL report the same value here, which is also the value the single-delete error payload carries.

AttributeDescriptionDeleteFailure.usage ● AttributeDescriptionUsageBreakdown object​

What is still holding the description. Present only for ATTRIBUTE_DESCRIPTION_IN_USE — the other two reasons never established a count.

Member Of​

AttributeDescriptionBulkDeleteResponse object