Schema Reference
Every query, type, field and argument the Refersion GraphQL API exposes. These pages are generated from the running schema, so they describe what the API actually accepts today.
The API is read-only: there is no mutation type. Everything hangs off a single root query.
Availability
The schema you get depends on the token you authenticate with, so a few fields are marked in the tables that follow:
| Marking | Meaning |
|---|---|
| no marking | Available to every token. |
| Merchant tokens only | Only for tokens generated from a Refersion merchant account. |
| Marketplace tokens only | Only for tokens generated from a Refersion Marketplace account. |
| Marketplace VIP tokens only | Only for marketplace accounts with VIP access enabled. |
What you can see
You only ever receive your own data — the API scopes every query for you, and there is no argument that widens it:
- Merchant tokens see the records belonging to your Refersion account.
- Marketplace tokens see the records of the affiliate accounts linked to your marketplace user, across every merchant you are approved with.
Some records are filtered out before any argument you pass is applied. Those exclusions are noted
on the relevant field — see Affiliate.status,
Conversion.status and
ConversionTrigger.status in particular.
Types
| Type | Description |
|---|---|
| Affiliate | Affiliates of clients |
| Click | An affiliate's click |
| Conversion | A Conversion |
| ConversionTrigger | A coupon code, email, or sku, that triggers a conversion for an affiliate. |
| Creative | A creative |
| Image | Product Feed Images |
| Merchant | The connected store a product-feed product was synced from. |
| Offer | An offer |
| PageInfo | Pagination information about a query's result set. |
| PageInfoPayload | Contains information about the paginated data |
| Payment | A payment |
| Platform | Product Feed Platforms |
| Product | Collects information regarding products. |
| ProductFeed | Affiliates Feed Products |
| Shop | A shop |
| Variant | Product Feed Variants |
Download the schema
The full SDL, if you would rather generate a client or explore it in a tool:
- Merchant schema
- Marketplace schema
- Marketplace VIP schema — the marketplace schema plus the fields marked Marketplace VIP tokens only above.
Related
- Filtering and Sorting — how arguments behave across every query.
- Pagination — fetch result sets larger than one page.
- Getting Started — the endpoint and authentication.