OBJECT

Mutation

link GraphQL Schema definition

1type Mutation {
2
3# Adds CSR comments to the order.
4#
5# Equivalent to POST /store/{storeId}/order/{orderId}/comment
6#
7# Arguments
8# mode: CSR add comment mode.
9# orderId: The order identifier.
10# requestBody: Information required to add CSR comment.
11# responseFormat: The response format. Valid values are json and
12# xml. If the request contains an input body, it must use the format specified in
13# responseFormat. If the responseFormat is not specified, the accept HTTP header
14# determines the format of the response. If the accept HTTP header is not
15# specified then default response format is json.
16# storeId: The store identifier.
17orderAddCSROrderComments(
18mode: Mode,
19orderId: String!,
20requestBody: orderCSRCommentFormInput,
21responseFormat: ResponseFormat,
22storeId: String!
23): CSRCommentResponseForm
153
24# Copies an order for a specified external order ID.
25#
26# Equivalent to POST /store/{storeId}/order/copy_oms_order/{extOrderId}
27#
28# Arguments
29# extOrderId: The external order identifier.
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.
36orderCopyOMSOrderByExternalOrderId(
37extOrderId: String!,
38responseFormat: ResponseFormat,
39storeId: String!
40): String
153
41# Deletes the order history for the authenticated user.
42#
43# Equivalent to DELETE /store/{storeId}/order/@history
44#
45# Arguments
46# storeId: The store identifier.
47# userId: The user identifier.
48orderDeleteOrderHistory(storeId: String!, userId: String!): OrderOrderHistoryResponse
153
49# Processes an order for a specified external order ID.
50#
51# Equivalent to POST /store/{storeId}/order/process_oms_order/{extOrderId}
52#
53# Arguments
54# extOrderId: The external order identifier.
55# responseFormat: The response format. Valid values are json and
56# xml. If the request contains an input body, it must use the format specified in
57# responseFormat. If the responseFormat is not specified, the accept HTTP header
58# determines the format of the response. If the accept HTTP header is not
59# specified then default response format is json.
60# storeId: The store identifier.
61orderProcessOMSOrderByExternalOrderId(
62extOrderId: String!,
63responseFormat: ResponseFormat,
64storeId: String!
65): String
153
66# Creates a wish list. The wish list can contain items, or be empty.
67#
68# Equivalent to POST /store/{storeId}/wishlist
69#
70# Arguments
71# requestBody: Description of the post input body to create a
72# wish list or item.
73# responseFormat: The response format. Valid values are json and
74# xml. If the request contains an input body, it must use the format specified in
75# responseFormat. If the responseFormat is not specified, the accept HTTP header
76# determines the format of the response. If the accept HTTP header is not
77# specified then default response format is json.
78# storeId: The store identifier.
79wishlistCreateWishlist(
80requestBody: createWishlistBodyParameterDescInput,
81responseFormat: ResponseFormat,
82storeId: String!
83): wishListResponse
153
84# Deletes a wish list or delete an item from a wish list. Specify an itemId or a
85# productId to delete only that item from the wish list; otherwise the entire wish
86# list is deleted. When both itemId and productId are provided, itemId is used
87# ONLY.
88#
89# Equivalent to DELETE /store/{storeId}/wishlist/{externalId}
90#
91# Arguments
92# externalId: Wish list external identifier.
93# itemId: Specifies the ID of the wish list item to delete. If
94# this parameter and productId are missing or blank, the entire wish list is
95# deleted.
96# productId: Specifies the id of the wish list product to delete.
97# If this parameter and itemId are missing or blank, the entire wish list is
98# deleted.
99# responseFormat: The response format. Valid values are json and
100# xml. If the request contains an input body, it must use the format specified in
101# responseFormat. If the responseFormat is not specified, the accept HTTP header
102# determines the format of the response. If the accept HTTP header is not
103# specified then default response format is json.
104# storeId: The store identifier.
105wishlistDeleteWishlist(
106externalId: String!,
107itemId: String,
108productId: String,
109responseFormat: ResponseFormat,
110storeId: String!
111): deleteWishListResponse
153
112# Processes a wish list.
113#
114# Equivalent to POST /store/{storeId}/wishlist/{externalId}
115#
116# Arguments
117# action: The action of the rest service. Action parameter is
118# required for storing announcement
119# externalId: Wish list external identifier.
120# requestBody: Description of the post input body to process the
121# wish list.
122# storeId: The store identifier.
123wishlistProcessWishlist(
124action: Action,
125externalId: String!,
126requestBody: processWishlistBodyParameterDescInput,
127storeId: String!
128): wishListResponse
153
129# Updates the wish list to change the description or to add or update an item.
130#
131# Equivalent to PUT /store/{storeId}/wishlist/{externalId}
132#
133# Arguments
134# addItem: When set to true, a new item in a request is added to
135# the wish list. When false or missing, the wish list description and/or item is
136# updated with the information in the request. Default is false.
137# externalId: Wish list external identifier.
138# requestBody: Description of the post input body to update the
139# wishlist or item.
140# responseFormat: The response format. Valid values are json and
141# xml. If the request contains an input body, it must use the format specified in
142# responseFormat. If the responseFormat is not specified, the accept HTTP header
143# determines the format of the response. If the accept HTTP header is not
144# specified then default response format is json.
145# storeId: The store identifier.
146wishlistUpdateWishlist(
147addItem: AddItem,
148externalId: String!,
149requestBody: UpdateWishlistBodyParameterDescInput,
150responseFormat: ResponseFormat,
151storeId: String!
152): updateWishListResponse
154
155}

link Required by

This element is not required by anyone