OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Get the currently available Twitch Prime Offers.
4# Optional - Date override in UTC to view the offers available for a specific
5# date for allowlist accounts. Defaults to current time.
6# Optional - Group filter restricts the returned offers to the ones that contain a
7# group tag equal to the one passed.
8primeOffers(dateOverride: Time, group: String): [PrimeOffer]
9
10# Get a Journey by its ID
11# Optional - Date override in UTC to view the journey on a specific date for
12# allowlist accounts. Defaults to current time.
13# Optional - String debug will display the string id and locale for string assets
14journey(journeyId: String!, dateOverride: Time, stringDebug: Boolean): Journey
15
16# Get the Twitch Prime user information for the current signed in user.
17currentUser: CurrentUser
18
19# Evaluate the weblab for the current user.
20# This query also triggers the weblab, so take care to only execute the query
21# when the customer will actually be interacting with the relevant experience.
22weblabTreatment(weblabName: String!): Weblab
23
24# Evaluate the list of weblabs for the current user.
25# This query does not query the weblabs.
26weblabTreatmentList(weblabNameList: [String!]!): [Weblab!]!
27
28# Get the third-party account links for the given types
29accountLinks(accountTypes: [String!]!): [AccountLink]
30
31# Get a short-lived auth token representing a Twitch user. The token can be used
32# to fetch basic Twitch Account info, or to link the Twitch Account to the current
33# user.
34twitchUserAuthToken(
35authCode: String!,
36authState: TwitchOAuthState!
37): String
38
39# Get basic Twitch Account information from the passed in Twitch user auth token.
40twitchAccountFromAuthToken(authToken: String!): TwitchAccount
41
42# Get sets of translated strings associated with benefits for the detected country
43# of the user
44# Returns null if country is not supported by Amazon (embargoed)
45# primeMarketplaceCountryCode - (Optional) used to override the user's country
46# code.
47primeBenefitStrings(primeMarketplaceCountryCode: String): PrimeBenefitStrings
48
49# Custom configuration for a requested page.
50# Optional - String debug will display the string id and locale for string assets
51pageConfiguration(
52requestedPage: String!,
53dateOverride: Time,
54stringDebug: Boolean
55): PageConfiguration
56
57# Retrieves all of the customer's orders if no parameters are passed in
58# Optional - offerId will retrieve all of the customer's orders that are for that
59# offerId
60# Optional - orderId will retrieve that specific order. An orderId can not be
61# passed in without an offerId
62# Optional - orders will retrieve specific information for the order information
63# passed in
64orders(
65orderId: String,
66offerId: String,
67ordersDetails: [OfferOrderRetrievalDetails!]
68): [OfferOrderInformation!]
69
70# Supported configuration options made available through the developer console.
71developerConsoleOptions: DeveloperConsoleOptions
72
73# The Amazon Marketplace for the user - either real or a best guess for non-Prime
74# users.
75# If non-Prime, based on Country of Residence.
76# If authed and Prime, based on real Marketplace.
77# If the user has Prime in multiple Marketplaces, returns the one that matches the
78# users Country of Residence.
79# Returns null if the User's countryOfResidence is not supported
80# (EXCLUDED/EMBARGOED).
81primeMarketplace: PrimeMarketplace
82
83# Country where the current user resides.
84countryOfResidence: Country
85
86# Get an Item by its ID
87# Optional - Date override in UTC to view the item on a specific date for
88# allowlist accounts. Defaults to current time.
89# Optional - String debug will display the string id and locale for string assets
90# Optional - PreviewId is used to retrieve the previewed metadata for current Item
91item(itemId: String!, dateOverride: Time, stringDebug: Boolean, previewId: String): Item
92
93# Get a paginated list of items based on input values.
94#
95# Arguments
96# pageSize: Number of items to fetch in a page.
97# token: Pagination token returned by last query.
98# collectionType: Which group of items to get.
99# dateOverride: Override the date used for discovery,
100# eligibility, etc. Defaults to current time.
101# enableStringDebug: Whether or not to display string ID + locale
102# for string assets.
103items(
104pageSize: Int,
105token: String,
106collectionType: ItemCollectionType,
107dateOverride: Time,
108enableStringDebug: Boolean
109): ItemsPage
110
111}

link Required by

This element is not required by anyone