AdAccountConnection
One page of the merchant’s advertising accounts, connected or not.
AdAccountEdge
One ad account together with the cursor that marks its position in the connection.
AdAccount
One advertising account, on one platform. A merchant may hold SEVERAL accounts on the same platform — a Meta merchant typically has Facebook, Instagram and WhatsApp Business — so do not key a collection of these by provider. An account is listed here even on a platform the merchant has not connected yet; read status and platform { connected } rather than inferring either from the account’s presence.
AdMonthlyTotals
What one advertising platform, or one account on it, reports for the merchant’s current month.
AdPlatformConnection
One page of the merchant’s advertising platforms.
AdPlatformEdge
One advertising platform together with the cursor that marks its position in the connection.
AdPlatformHealth
How well one advertising platform is set up, scored out of ten and broken into the four things that move the score — so a merchant sees what to fix rather than only how bad it is.
AdPlatform
One advertising platform, and the figures it reports for this merchant. A platform exists here whether or not the merchant has connected it: seeing what a channel would cost before committing to it is the point of the module.
AdWeeklyPoint
One week of a reporting window — the granularity every chart in the advertising module draws at.
AdsPageInfo
Where the caller is in a paged list: whether more pages exist in either direction, and the cursors that fetch them.
BlendedMetrics
The merchant’s advertising totals across every platform at once — what a customer actually costs, rather than what each channel reports on its own. Platforms the merchant is only trialling are reported alongside these totals and left out of them, so trialling a channel cannot move the number a lender reads.
CampaignActionError
Returned when an action on a campaign was refused for a business reason rather than a transport or permission failure.
CampaignConnection
One page of the merchant’s advertising campaigns.
CampaignEdge
One campaign together with the cursor that marks its position in the connection.
CampaignPaused
Returned when the campaign was paused and the change was recorded.
Campaign
One advertising campaign inside one of the merchant’s ad accounts, with the spend and conversions attributed to it so far.
ChannelSummary
What one selling surface contributed to a period.
ContractConnection
A connection to a list of items.
ContractEdge
One agreement together with the cursor that marks its position in the connection.
Contract
An agreement between the merchant and somebody they do business with.
DateRange
The span of days a summary actually covered, echoed back so a stored report
DisputeAcknowledged
Returned when the acknowledgement was recorded.
DisputeActionError
Returned when nothing was recorded for a business reason rather than a
DisputeConnection
A connection to a list of items.
DisputeEdge
One dispute together with the cursor that marks its position in the connection.
Dispute
A payment the customer's bank has questioned on their behalf — a chargeback.
DocumentConnection
A connection to a list of items.
DocumentEdge
One file together with the cursor that marks its position in the connection.
DocumentFinalizeError
Returned when the record was not made available, for a business reason rather
DocumentFinalized
Returned when the file was found where it was expected, matched what was
DocumentUploadError
Returned when nothing was accepted for a business reason rather than a
DocumentUploadStarted
Returned when the file was accepted and there is somewhere to send it.
Document
A file the merchant keeps with their agreements — the signed paper, a
EmployeeConnection
A connection to a list of items.
EmployeeEdge
One employee together with the cursor that marks its position in the connection.
Employee
A person on the merchant's payroll: who they are, how they are employed,
GatewaySplitEntry
What one processor contributed to a period.
LeaveRequestConnection
A connection to a list of items.
LeaveRequestCreated
Returned when the leave request was accepted and stored.
LeaveRequestEdge
One leave request together with the cursor that marks its position in the connection.
LeaveRequest
A request from an employee for a period of time off, together with where it
LeaveValidationError
Returned when the leave request was rejected for a business reason rather
Merchant
The merchant business this data belongs to — the name, trade and reporting
MethodMixEntry
What one way of paying contributed to a period.
Money
An amount of money, always as a whole number of the currency’s minor unit so no rounding can happen on the wire.
OrderConnection
A connection to a list of items.
OrderEdge
One order together with the cursor that marks its position in the connection.
OrderLine
One item on an order: what was bought, how many, and at what price on the
Order
One sale: what a customer bought, through which channel, what they paid, and
PageCursor
A cursor that points to a specific page.
PageInfo
Information about pagination in a connection.
PaymentsPeriod
The span of days a summary actually covered, echoed back so a stored report
PaymentsSummary
How a merchant was paid over a period: the headline figures a dashboard
PayoutConnection
A connection to a list of items.
PayoutEdge
One payout together with the cursor that marks its position in the connection.
Payout
One transfer of money from a processor into the merchant's bank account,
ProductConnection
A connection to a list of items.
ProductEdge
One product together with the cursor that marks its position in the connection.
ProductPriceAdjusted
Returned when the price was changed and stored.
ProductPriceError
Returned when the price was not changed for a business reason rather than a
Product
Something the merchant sells: one stock-keeping unit, its current price, and
SalesSummary
How a merchant sold over a period: the headline figures a dashboard shows,
SettlementConnection
A connection to a list of items.
SettlementEdge
One payment together with the cursor that marks its position in the connection.
Settlement
One payment the merchant took: what was captured, on which rail, what the