OBJECT

Mutation

link GraphQL Schema definition

1type Mutation {
2
3# Checks if the password is valid.
4#
5# Equivalent to POST /store/{storeId}/previewToken/isvalid
6#
7# Arguments
8# requestBody: [Not documented]
9# storeId: The store identifier.
10checkIsPasswordValid(
11requestBody: passwordValidRequestInput!,
12storeId: String!
13): previewTokenValidIdentifier
182
14# Logs out the user.
15#
16# Equivalent to DELETE /store/{storeId}/ltpaidentity/@self
17#
18# Arguments
19# responseFormat: The response format. If the request has an
20# input body, that body must also use the format specified in "responseFormat".
21# Valid values include �json� and �xml� without the quotes. If the responseFormat
22# isn�t specified, the �accept� HTTP header shall be used to determine the format
23# of the response. If the �accept� HTTP header isn�t specified as well, the
24# default response format shall be in json.
25# storeId: The store identifier.
26deleteStoreStoreIdLtpaidentitySelf(
27responseFormat: String,
28storeId: String!
29): String
182
30# Requests the preview token.
31#
32# Equivalent to POST /store/{storeId}/previewToken
33#
34# Arguments
35# requestBody: [Not documented]
36# responseFormat: The response format. Valid values are json and
37# xml. If the request contains an input body, it must use the format specified in
38# responseFormat. If the responseFormat is not specified, the accept HTTP header
39# determines the format of the response. If the accept HTTP header is not
40# specified then default response format is json.
41# storeId: The store identifier.
42generatePreviewToken(
43requestBody: previewTokenParametersInput,
44responseFormat: ResponseFormat,
45storeId: String!
46): previewToken
182
47# Creates identity tokens for a guest user.
48#
49# Equivalent to POST /store/{storeId}/guestidentity
50#
51# Arguments
52# requestBody: Information needed to creating guest identity.
53# responseFormat: The response format. Valid values are json and
54# xml. If the request contains an input body, it must use the format specified in
55# responseFormat. If the responseFormat is not specified, the accept HTTP header
56# determines the format of the response. If the accept HTTP header is not
57# specified then default response format is json.
58# storeId: The store identifier.
59guestIdentityLogin(
60requestBody: guestIdentityFormInput,
61responseFormat: ResponseFormat,
62storeId: String!
63): guestUserIdentity
182
64# Logs out a guest user.
65#
66# Equivalent to DELETE /store/{storeId}/guestidentity/@self
67#
68# Arguments
69# responseFormat: The response format. Valid values are json and
70# xml. If the request contains an input body, it must use the format specified in
71# responseFormat. If the responseFormat is not specified, the accept HTTP header
72# determines the format of the response. If the accept HTTP header is not
73# specified then default response format is json.
74# storeId: The store identifier.
75guestIdentityLogout(
76responseFormat: ResponseFormat,
77storeId: String!
78): String
182
79# Logs in a registered user using their user name and password.
80#
81# Equivalent to POST /store/{storeId}/loginidentity
82#
83# Arguments
84# requestBody: Information required to authenticate a user.
85# responseFormat: The response format. Valid values are json and
86# xml. If the request contains an input body, it must use the format specified in
87# responseFormat. If the responseFormat is not specified, the accept HTTP header
88# determines the format of the response. If the accept HTTP header is not
89# specified then default response format is json.
90# storeId: The store identifier.
91loginIdentityLogin(
92requestBody: loginIdentityFormInput,
93responseFormat: ResponseFormat,
94storeId: String!
95): loginUserIdentity
182
96# Logs out the registered user.
97#
98# Equivalent to DELETE /store/{storeId}/loginidentity/@self
99#
100# Arguments
101# responseFormat: The response format. Valid values are json and
102# xml. If the request contains an input body, it must use the format specified in
103# responseFormat. If the responseFormat is not specified, the accept HTTP header
104# determines the format of the response. If the accept HTTP header is not
105# specified then default response format is json.
106# storeId: The store identifier.
107loginIdentityLogout(
108responseFormat: ResponseFormat,
109storeId: String!
110): String
182
111# Generate access token based on authorization code passed or validate the passed
112# access token. Validate the user details and create a new user if not registered.
113#
114# Equivalent to POST /store/{storeId}/loginidentity/oauth_validate
115#
116# Arguments
117# requestBody: [Not documented]
118# responseFormat: The response format. If the request has an
119# input body, that body must also use the format specified in \"responseFormat\".
120# Valid values include \"json\" and \"xml\" without the quotes. If the
121# responseFormat.
122# storeId: The store identifier.
123postStoreStoreIdLoginidentityOauthValidate(
124requestBody: tokenValidationFormInput,
125responseFormat: ResponseFormat,
126storeId: String!
127): loginOAuthUserIdentity
182
128# Authenticates a user using an LTPA token.
129#
130# Equivalent to POST /store/{storeId}/ltpaidentity
131#
132# Arguments
133# requestBody: [Not documented]
134# responseFormat: The response format. If the request has an
135# input body, that body must also use the format specified in "responseFormat".
136# Valid values include �json� and �xml� without the quotes. If the responseFormat
137# isn�t specified, the �accept� HTTP header shall be used to determine the format
138# of the response. If the �accept� HTTP header isn�t specified as well, the
139# default response format shall be in json.
140# storeId: The store identifier.
141postStoreStoreIdLtpaidentity(
142requestBody: LTPAIdentityFormInput!,
143responseFormat: String,
144storeId: String!
145): LTPAUserIdentity
182
146# Response the contract change action.
147#
148# Equivalent to PUT /store/{storeId}/switchContract/switchTo
149#
150# Arguments
151# requestBody: [Not documented]
152# responseFormat: The response format. If the request has an
153# input body, that body must also use the format specified in "responseFormat".
154# Valid values include �json� and �xml� without the quotes. If the responseFormat
155# isn�t specified, the �accept� HTTP header shall be used to determine the format
156# of the response. If the �accept� HTTP header isn�t specified as well, the
157# default response format shall be in json.
158# storeId: The store identifier.
159putStoreStoreIdSwitchContractSwitchTo(
160requestBody: switchContractRequestInput,
161responseFormat: String,
162storeId: String!
163): switchContractResponse
182
164# Response the organization change action
165#
166# Equivalent to PUT /store/{storeId}/switchOrganization/switchTo
167#
168# Arguments
169# requestBody: [Not documented]
170# responseFormat: The response format. If the request has an
171# input body, that body must also use the format specified in "responseFormat".
172# Valid values include �json� and �xml� without the quotes. If the responseFormat
173# isn�t specified, the �accept� HTTP header shall be used to determine the format
174# of the response. If the �accept� HTTP header isn�t specified as well, the
175# default response format shall be in json.
176# storeId: The store identifier.
177putStoreStoreIdSwitchOrganizationSwitchTo(
178requestBody: switchOrganizationInput,
179responseFormat: String,
180storeId: String!
181): switchOrganizationResponse
183
184}

link Required by

This element is not required by anyone