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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
<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.returnpolicyonline.html">returnpolicyonline</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new return policy.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, returnPolicyId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing return policy.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, returnPolicyId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an existing return policy.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all existing return policies.</p>
<p class="toc_element">
<code><a href="#patch">patch(merchantId, returnPolicyId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing return policy.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code>
<pre>Creates a new return policy.
Args:
merchantId: string, Required. The id of the merchant for which to retrieve the return policy online object. (required)
body: object, The request body.
The object takes the form of:
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, returnPolicyId, x__xgafv=None)</code>
<pre>Deletes an existing return policy.
Args:
merchantId: string, Required. The id of the merchant for which to retrieve the return policy online object. (required)
returnPolicyId: string, Required. The id of the return policy to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, returnPolicyId, x__xgafv=None)</code>
<pre>Gets an existing return policy.
Args:
merchantId: string, Required. The id of the merchant for which to retrieve the return policy online object. (required)
returnPolicyId: string, Required. The id of the return policy to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, x__xgafv=None)</code>
<pre>Lists all existing return policies.
Args:
merchantId: string, Required. The id of the merchant for which to retrieve the return policy online object. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `ListReturnPolicyOnline` method.
"returnPolicies": [ # The retrieved return policies.
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(merchantId, returnPolicyId, body=None, x__xgafv=None)</code>
<pre>Updates an existing return policy.
Args:
merchantId: string, Required. The id of the merchant for which to retrieve the return policy online object. (required)
returnPolicyId: string, Required. The id of the return policy to update. (required)
body: object, The request body.
The object takes the form of:
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Return policy online object. This is currently used to represent return policies for ads and free listings programs.
"countries": [ # The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
"A String",
],
"itemConditions": [ # The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"label": "A String", # The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
"name": "A String", # The name of the policy as shown in Merchant Center.
"policy": { # The available policies. # The return policy.
"days": "A String", # The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
"type": "A String", # Policy type.
},
"restockingFee": { # The restocking fee. This can either be a fixed fee or a micro percent. # The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
"fixedFee": { # The price represented as a number and currency. # Fixed restocking fee.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"microPercent": 42, # Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.
},
"returnMethods": [ # The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
"A String",
],
"returnPolicyId": "A String", # Output only. Return policy ID generated by Google.
"returnPolicyUri": "A String", # The return policy uri. This can used by Google to do a sanity check for the policy.
"returnReasonCategoryInfo": [ # The return reason category information. This required to not be empty unless the type of return policy is noReturns.
{ # The return reason category info wrapper.
"returnLabelSource": "A String", # The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
"returnReasonCategory": "A String", # The return reason category.
"returnShippingFee": { # The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost. # The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.
"fixedFee": { # The price represented as a number and currency. # Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"type": "A String", # Type of return shipping fee.
},
},
],
}</pre>
</div>
</body></html>
|
