Skip to main content

Site

A site: one trading location. Everything else is read through a site.

type Site {
  id: ID!
  name: String
  currency: String
  timezone: String
  rolloverHour: Int
  categories: [Category!]!
  products(
    first: Int = 100
    after: String
  ): ProductPage!
  modifierGroups: [ModifierGroup!]!
  orders(
    from: DateTime!
    to: DateTime!
    first: Int = 100
    after: String
  ): OrderPage!
  refunds(
    from: DateTime!
    to: DateTime!
    first: Int = 100
    after: String
  ): RefundPage!
  dailySummary(
    from: Date!
    to: Date!
  ): [DailySummary!]!
}

Fields​

Site.id ● ID! non-null scalar​

Site.name ● String scalar​

Site.currency ● String scalar​

ISO 4217 code for every amount at this site.

Site.timezone ● String scalar​

IANA time zone the site trades in.

Site.rolloverHour ● Int scalar​

Hour of the local day at which a new business date starts.

Site.categories ● [Category!]! non-null object​

Needs the read:products permission.

Site.products ● ProductPage! non-null object​

Needs the read:products permission.

Site.products.first ● Int scalar​
Site.products.after ● String scalar​

Site.modifierGroups ● [ModifierGroup!]! non-null object​

Needs the read:products permission.

Site.orders ● OrderPage! non-null object​

Orders closed from from up to but not including to, oldest first. Voided orders are included and flagged. At most 92 days per request. Needs the read:reports permission.

Site.orders.from ● DateTime! non-null scalar​
Site.orders.to ● DateTime! non-null scalar​
Site.orders.first ● Int scalar​
Site.orders.after ● String scalar​

Site.refunds ● RefundPage! non-null object​

Refunds made from from up to but not including to, oldest first. A refund is its own record, dated when it happened, and can fall on a later day than the order it refunds. At most 92 days per request. Needs the read:reports permission.

Site.refunds.from ● DateTime! non-null scalar​
Site.refunds.to ● DateTime! non-null scalar​
Site.refunds.first ● Int scalar​
Site.refunds.after ● String scalar​

Site.dailySummary ● [DailySummary!]! non-null object​

Sales totals per business date, calculated the same way as the Seamless reports. At most 31 days per request. Needs the read:reports permission.

Site.dailySummary.from ● Date! non-null scalar​
Site.dailySummary.to ● Date! non-null scalar​

Returned By​

site query ● sites query