Skip to main content

Get Bulk Edit Metadata

GET 
/api/v2/products/bulk-edit-metadata

Returns the dynamic field definitions available to bulk product edits: product attributes (with their type, display configuration, validation rules and configured options), product pricing tiers, supplier pricing tiers, and suppliers.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each attribute includes:

  • type — stored data type: string, longtext, numeric, integer, date, datetime, checkbox
  • has_options — whether values are restricted to a configured option list
  • options — the configured option values as plain strings
  • attribute_options — the same options with per-option swatch data (value, swatch_hex, swatch_image_url, sort_order)
  • display_options — has_options, type (Single or Multi), option_display_type (e.g. swatch), allow_custom_value, is_html, is_link, sort_order
  • validation — optional constraints: limit (max characters), precision (decimal places), min, max
  • group_name — the attribute group the attribute belongs to, or Ungrouped

Multi-value attributes (display_options.type = Multi) hold every selected value in a single newline-separated string. Send them back the same way when setting a value.

Archived attributes are excluded. Attributes are ordered by name.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type