Skip to content

Object

PhysicalProduct

A physical product (merchandise, equipment, etc.) offered by a business. Has finite inventory and must be fulfilled by staff handing the item to the purchaser after payment.

Implements

Fields

idID!
stripePublishableKeyString!
stripeConnectedAccountIdID

The business's connected account for its active Stripe mode; the client initialises Stripe.js with this for direct charges. Null until onboarding completes.

nameString

Resolved for the given locale, falling back to English. Defaults to the viewer's locale.

Arguments (1)
localeLocale
priceInt!
purchaseRulesProductPurchaseRules!
effectivePriceInt!
sortOrderInt!
inventoryInt

Current stock on hand. Null means inventory is untracked (unlimited).

allowOversellingBoolean!

When true, purchases succeed even at zero inventory (inventory can go negative). When false, purchases are refused once inventory is exhausted. Ignored when inventory is null.

fulfillmentInstructionsString

Free-form copy shown to buyers and staff describing how the product will be handed over (e.g. "Pick up at the front desk during class hours"). Resolved for the given locale, falling back to English.

Arguments (1)
localeLocale
soldOutBoolean!

Whether the product is currently unavailable because inventory is exhausted and overselling is disabled.