Skip to main content

Product extras model

An Extra is a business-level group of product choices. It is the parent of extra options; an option is the parent of its selectable suboptions. Keep those three identities separate when building paths or payloads.

Operations​

ActionMethodResource
ListGET/business/{business_id}/extras
FindGET/business/{business_id}/extras/{extra_id}
CreatePOST/business/{business_id}/extras
UpdatePUT/business/{business_id}/extras/{extra_id}
DeleteDELETE/business/{business_id}/extras/{extra_id}

These operations require authentication. Write access is limited to administrators and business managers; managers are scoped to businesses associated with their user.

Shared concepts​

The model includes identifiers and visible fields such as id, business_id, name, description, enabled, external_id, rank, and snooze_until. Its options relation contains ExtraOption records; metafields contains metadata attached specifically to the Extra model.

See load options for product extras for relation-loading behavior and the extra option model for the next identity in the hierarchy.