Merchant

Describes a merchant.

Type Definition


type Merchant {
  isOnTrial: Boolean
  address: Address
  isCompany: Boolean
  dateFormat: String
  timeFormat: String
  datetimeFormat: String
  timeZone: String
}

Fields

Field	Type	Nullable	Description	Related Type
`isOnTrial`	Boolean	Yes	Returns true if merchant is on trial.
`address`	Address	Yes	Returns the merchant address.	Address
`isCompany`	Boolean	Yes	Returns true if merchant is a company.
`dateFormat`	String	Yes	Returns the default date format.
`timeFormat`	String	Yes	Returns the default time format.
`datetimeFormat`	String	Yes	Returns the default datetime format.
`timeZone`	String	Yes	Returns the merchant time zone.

Relationships

address: This field links the Merchant type to the Address object type, representing the merchant’s physical or mailing address. You can traverse this relationship to access detailed address information such as street, city, postal code, and country (depending on the Address type definition).

Usage Examples

Basic Query


query {
  merchant {
    isOnTrial
    isCompany
    dateFormat
    timeZone
  }
}

Field Selection


query {
  merchant {
    isOnTrial
    address {
      street
      city
      postalCode
      country
    }
    datetimeFormat
  }
}

Nested Queries


query {
  merchant {
    address {
      street
      city
      country
    }
    timeFormat
  }
}

Filtering and Sorting

The Merchant type does not support filtering, sorting, or pagination directly as it represents a single entity rather than a collection.

Implements

The Merchant type does not implement any interfaces.

Connections

The Merchant type does not have any connection fields for pagination.

Address: Represents the merchant’s address details. Use the address field on Merchant to access this type.

Best Practices

When querying the address field, select only the necessary subfields to optimize response size.
Use the date and time format fields (dateFormat, timeFormat, datetimeFormat) to format dates and times consistently on the client side.
Check the isOnTrial and isCompany boolean fields to conditionally render UI elements or enable features based on merchant status.
Since all fields are optional, always implement null checks in your client code to avoid runtime errors.

Notes

The API currently requires no authentication, but this may change in future versions.
The Merchant object represents a single merchant entity, so it is typically returned as part of a root query or embedded within other objects.
There are no computed or derived fields in this type.
No field arguments are defined on any fields of Merchant.
Performance considerations: Since the Merchant type contains only scalar and a single nested object field, queries are lightweight. Avoid requesting unnecessary nested fields to keep responses efficient.