Skip to main content

Store

Merchant store (physical location or online shop) within an account. Stores group points of sale and other resources for multi-store businesses. Hierarchy: Account > Store > PointOfSale > Terminal.

type Store {
id: ID!
name: String
address: Address
phone: String
email: String
iban: String
website: String
metadata: [KeyValueItem!]
blocked: Boolean
}

Fields

Store.id ● ID! non-null scalar

Store ID.

Store.name ● String scalar

Display name.

Store.address ● Address object

Postal address of the store.

Store.phone ● String scalar

Contact phone in E.164 format, e.g. +34666777888.

Store.email ● String scalar

Contact email.

Store.iban ● String scalar

Sensitive: merchant payout account. IBAN used for settlements attributed to this store.

Store.website ● String scalar

Public website URL.

Store.metadata ● [KeyValueItem!] list object

Arbitrary key/value metadata.

Store.blocked ● Boolean scalar

Whether the store is blocked. Blocked stores cannot accept payments.

Returned By

createStore mutation ● store query ● updateStore mutation

Member Of

StoresConnection object