OBJECT

Mutation

link GraphQL Schema definition

1type Mutation {
2
3# Adds a widget to a layout.
4#
5# Equivalent to PUT /store/{storeId}/layout/{layoutId}/widget
6#
7# Arguments
8# layoutId: The layout unique ID.
9# requestBody: [Not documented]
10# responseFormat: The response format. Valid values are json and
11# xml. If the request contains an input body, it must use the format specified in
12# responseFormat. If the responseFormat is not specified, the accept HTTP header
13# determines the format of the response. If the accept HTTP header is not
14# specified then default response format is json.
15# storeId: The store identifier.
16layoutAddwidget(
17layoutId: String!,
18requestBody: LayoutAddwidgetInput!,
19responseFormat: ResponseFormat,
20storeId: String!
21): LayoutAddwidgetResponse
167
22# Creates the layout.
23#
24# Equivalent to PUT /store/{storeId}/layout
25#
26# Arguments
27# autoGenerateName: The server automatically generates a name for
28# the layout.
29# requestBody: [Not documented]
30# responseFormat: The response format. Valid values are json and
31# xml. If the request contains an input body, it must use the format specified in
32# responseFormat. If the responseFormat is not specified, the accept HTTP header
33# determines the format of the response. If the accept HTTP header is not
34# specified then default response format is json.
35# storeId: The store identifier.
36layoutCreateLayout(
37autoGenerateName: Boolean,
38requestBody: LayoutCreatenewInput!,
39responseFormat: ResponseFormat,
40storeId: String!
41): LayoutCreatenewResponse
167
42# Deletes a layout for a specified store.
43#
44# Equivalent to DELETE /store/{storeId}/layout/{layoutId}
45#
46# Arguments
47# layoutId: The layout unique ID.
48# responseFormat: The response format. Valid values are json and
49# xml. If the request contains an input body, it must use the format specified in
50# responseFormat. If the responseFormat is not specified, the accept HTTP header
51# determines the format of the response. If the accept HTTP header is not
52# specified then default response format is json.
53# storeId: The store identifier.
54layoutDeleteLayout(
55layoutId: String!,
56responseFormat: ResponseFormat,
57storeId: String!
58): StoreLayout
167
59# Deletes a widget from a layout.
60#
61# Equivalent to DELETE /store/{storeId}/layout/{layoutId}/widget/{widgetId}
62#
63# Arguments
64# layoutId: The layout unique ID.
65# responseFormat: The response format. Valid values are json and
66# xml. If the request contains an input body, it must use the format specified in
67# responseFormat. If the responseFormat is not specified, the accept HTTP header
68# determines the format of the response. If the accept HTTP header is not
69# specified then default response format is json.
70# storeId: The store identifier.
71# widgetId: The widget unique ID.
72layoutDeleteWidget(
73layoutId: String!,
74responseFormat: ResponseFormat,
75storeId: String!,
76widgetId: String!
77): LayoutDeleteLayout
167
78# Performs an action on layout properties. See each action for details on input
79# and output.
80#
81# Equivalent to POST /store/{storeId}/layout/{layoutId}/layoutProperties
82#
83# Arguments
84# action: The action of the rest service.
85# layoutId: The layout unique ID.
86# requestBody: [Not documented]
87# storeId: The store identifier.
88layoutPerformLayoutPropertiesAction(
89action: Action!,
90layoutId: String!,
91requestBody: LayoutLayoutpropertiesRequestBodyInput,
92storeId: String!
93): LayoutLayoutpropertiesResponseBody
167
94# Performs an action on layout static location. See each action for details on
95# input and output.
96#
97# Equivalent to POST /store/{storeId}/layout/{layoutId}/layoutStaticLocation
98#
99# Arguments
100# action: The action of the rest service.
101# layoutId: The layout unique ID.
102# requestBody: [Not documented]
103# storeId: The store identifier.
104layoutPerformLayoutStaticLocationAction(
105action: Action3!,
106layoutId: String!,
107requestBody: LayoutLayoutInput,
108storeId: String!
109): String
167
110# Performs an action on widgets extended data. See each action for details on
111# input and output.
112#
113# Equivalent to POST
114# /store/{storeId}/layout/{layoutId}/widget/{widgetId}/extendedData
115#
116# Arguments
117# action: The action of the rest service.
118# layoutId: The layout unique ID.
119# requestBody: [Not documented]
120# storeId: The store identifier.
121# widgetId: The widget unique ID.
122layoutPerformWidgetExtendedDataAction(
123action: Action2!,
124layoutId: String!,
125requestBody: LayoutUpdatewidgetExtendeddataInput!,
126storeId: String!,
127widgetId: String!
128): LayoutUpdatewidgetExtendeddataResponse
167
129# Updates a layout in the store.
130#
131# Equivalent to POST /store/{storeId}/layout/{layoutId}
132#
133# Arguments
134# layoutId: The layout unique ID.
135# requestBody: [Not documented]
136# responseFormat: The response format. Valid values are json and
137# xml. If the request contains an input body, it must use the format specified in
138# responseFormat. If the responseFormat is not specified, the accept HTTP header
139# determines the format of the response. If the accept HTTP header is not
140# specified then default response format is json.
141# storeId: The store identifier.
142layoutUpdateLayout(
143layoutId: String!,
144requestBody: LayoutUpdatewidgetInput!,
145responseFormat: ResponseFormat,
146storeId: String!
147): LayoutUpdatewidgetResponse
167
148# Updates widget and widget properties in a layout.
149#
150# Equivalent to POST /store/{storeId}/layout/{layoutId}/widget
151#
152# Arguments
153# layoutId: The layout unique ID.
154# requestBody: [Not documented]
155# responseFormat: The response format. Valid values are json and
156# xml. If the request contains an input body, it must use the format specified in
157# responseFormat. If the responseFormat is not specified, the accept HTTP header
158# determines the format of the response. If the accept HTTP header is not
159# specified then default response format is json.
160# storeId: The store identifier.
161layoutUpdateWidget(
162layoutId: String!,
163requestBody: LayoutUpdatewidgetInput,
164responseFormat: ResponseFormat,
165storeId: String!
166): LayoutUpdatewidgetResponse
168
169}

link Required by

This element is not required by anyone