1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.orderreturns.html">orderreturns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(merchantId, returnId)</a></code></p>
<p class="firstline">Retrieves an order return from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, orderBy=None, pageToken=None, createdEndDate=None, maxResults=None, createdStartDate=None)</a></code></p>
<p class="firstline">Lists order returns in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(merchantId, returnId)</code>
<pre>Retrieves an order return from your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
returnId: string, Merchant order return ID generated by Google. (required)
Returns:
An object of the form:
{
"orderId": "A String",
"returnShipments": [
{
"returnMethodType": "A String",
"state": "A String",
"shipmentTrackingInfos": [
{
"trackingNumber": "A String",
"carrier": "A String",
},
],
"shipmentId": "A String",
"deliveryDate": "A String",
"creationDate": "A String",
"shippingDate": "A String",
},
],
"orderReturnId": "A String",
"returnItems": [
{
"itemId": "A String",
"product": {
"targetCountry": "A String", # The CLDR territory code of the target country of the product.
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"title": "A String", # The title of the product.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
{
"dimension": "A String", # The dimension of the variant.
"value": "A String", # The value for the dimension.
},
],
"brand": "A String", # Brand of the item.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"offerId": "A String", # An identifier of the item.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"imageLink": "A String", # URL of an image of the item.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"fees": [ # Associated fees at order creation time.
{
"amount": { # Amount of the fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the fee.
},
],
"id": "A String", # The REST ID of the product.
"condition": "A String", # Condition or state of the item.
},
"returnShipmentIds": [
"A String",
],
"state": "A String",
"customerReturnReason": {
"reasonCode": "A String",
"description": "A String",
},
"merchantReturnReason": {
"reasonCode": "A String",
"description": "A String",
},
},
],
"merchantOrderId": "A String",
"creationDate": "A String",
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, orderBy=None, pageToken=None, createdEndDate=None, maxResults=None, createdStartDate=None)</code>
<pre>Lists order returns in your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
orderBy: string, Return the results in the specified order.
Allowed values
returnCreationTimeAsc -
returnCreationTimeDesc -
pageToken: string, The token returned by the previous request.
createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format.
maxResults: integer, The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format.
Returns:
An object of the form:
{
"nextPageToken": "A String", # The token for the retrieval of the next page of returns.
"kind": "content#orderreturnsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse".
"resources": [
{
"orderId": "A String",
"returnShipments": [
{
"returnMethodType": "A String",
"state": "A String",
"shipmentTrackingInfos": [
{
"trackingNumber": "A String",
"carrier": "A String",
},
],
"shipmentId": "A String",
"deliveryDate": "A String",
"creationDate": "A String",
"shippingDate": "A String",
},
],
"orderReturnId": "A String",
"returnItems": [
{
"itemId": "A String",
"product": {
"targetCountry": "A String", # The CLDR territory code of the target country of the product.
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"title": "A String", # The title of the product.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
{
"dimension": "A String", # The dimension of the variant.
"value": "A String", # The value for the dimension.
},
],
"brand": "A String", # Brand of the item.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"offerId": "A String", # An identifier of the item.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"imageLink": "A String", # URL of an image of the item.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"fees": [ # Associated fees at order creation time.
{
"amount": { # Amount of the fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the fee.
},
],
"id": "A String", # The REST ID of the product.
"condition": "A String", # Condition or state of the item.
},
"returnShipmentIds": [
"A String",
],
"state": "A String",
"customerReturnReason": {
"reasonCode": "A String",
"description": "A String",
},
"merchantReturnReason": {
"reasonCode": "A String",
"description": "A String",
},
},
],
"merchantOrderId": "A String",
"creationDate": "A String",
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
