Mutation
addCustomAttributeOptions
Add options to a creator select field; names the field already has are skipped.
Arguments
- key String! required
- Key of a SINGLE_SELECT_V3 or MULTIPLE_SELECT_V2 creator field, as
customAttributeSchemas(entity: CREATOR)lists it. Thelabelskey is refused; usecreateLabels. - names [String!]! required
- Option names to add, 1 to 100, each at most 255 characters once trimmed. A field holds at most 500 options.
Returns
Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.
- addedOptionIds [ID!]!
- IDs of the options this call created, in submission order. Empty when every name existed.
- schema CustomAttributeSchema
- The field with all its options. Null when userErrors is non-empty.
- aiGenerated Boolean!
- True when this attribute's value is produced by an AI Filter. For AI-generated attributes, an item's
aiFilterReasonsentry with the matchingkeycarries the model's explanation for the value. - key String!
- Key used in the customAttributes object.
- name String!
- Human-readable display name.
- options [CustomAttributeOption!]
- Available options for select-type attributes. When present, customAttributes values are option IDs that map to these options. When null, values are stored directly (text, numbers, dates, etc.).
- id ID!
- Unique identifier. Match this against values in customAttributes. For the ITEM
collectionsschema this is a Collection'scustomAttributeOptionId, not itsid. - name String!
- Human-readable display name.
- type CustomAttributeType!
- Custom attribute field type.
- BOOLEAN
- True/false value.
- BOOLEAN_LIST
- List of true/false values.
- DATE
- Calendar date value (ISO 8601, no time component).
- DATETIME
- Date-and-time value (ISO 8601).
- DATETIME_LIST
- List of date-and-time values (ISO 8601).
- DATE_LIST
- List of calendar date values (ISO 8601, no time component).
- Email address value.
- MULTIPLE_SELECT
- Multiple choices from a predefined option list; the stored value is an array of option IDs.
- MULTIPLE_SELECT_V2
- Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
- NUMBER
- Numeric value.
- NUMBER_LIST
- List of numeric values.
- PHONE
- Phone number value.
- SHIPPING_ADDRESS
- Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
- SINGLE_SELECT_V2
- Single choice from a predefined option list; the stored value is an option ID.
- SINGLE_SELECT_V3
- Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
- TEXT
- Free-form text value.
- TEXT_LIST
- List of free-form text values.
- URL
- URL value.
- skippedNames [String!]!
- Submitted names the field already had, trimmed, in submission order. Nothing was added for them.
- userErrors [UserError!]!
- Errors that refused the request: an unknown, read-only or non-select key, the
labelskey, unusable names, or the option cap. Empty on success. - field [String!]
- Path to the input field that caused the error.
- message String!
- The error message.