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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
|
<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="content_v2_1.orderreturns.labels.html">labels()</a></code>
</p>
<p class="firstline">Returns the labels Resource.</p>
<p class="toc_element">
<code><a href="#acknowledge">acknowledge(merchantId, returnId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acks an order return in your Merchant Center account.</p>
<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="#createorderreturn">createorderreturn(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create return in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, returnId, x__xgafv=None)</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, acknowledged=None, createdEndDate=None, createdStartDate=None, googleOrderIds=None, maxResults=None, orderBy=None, pageToken=None, shipmentStates=None, shipmentStatus=None, shipmentTrackingNumbers=None, shipmentTypes=None, x__xgafv=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()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#process">process(merchantId, returnId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Processes return in your Merchant Center account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="acknowledge">acknowledge(merchantId, returnId, body=None, x__xgafv=None)</code>
<pre>Acks an order return 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)
returnId: string, The ID of the return. (required)
body: object, The request body.
The object takes the form of:
{
"operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order return.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderreturnsAcknowledgeResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="createorderreturn">createorderreturn(merchantId, body=None, x__xgafv=None)</code>
<pre>Create return 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)
body: object, The request body.
The object takes the form of:
{
"lineItems": [ # The list of line items to return.
{
"lineItemId": "A String", # The ID of the line item. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
"productId": "A String", # The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
"quantity": 42, # The quantity of this line item.
},
],
"operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
"orderId": "A String", # The ID of the order.
"returnMethodType": "A String", # The way of the package being returned.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderreturnsCreateOrderReturnResponse`".
"orderReturn": { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not. # Created order return.
"creationDate": "A String", # The date of creation of the return, in ISO 8601 format.
"merchantOrderId": "A String", # Merchant defined order ID.
"orderId": "A String", # Google order ID.
"orderReturnId": "A String", # Order return ID generated by Google.
"returnItems": [ # Items of the return.
{
"customerReturnReason": { # The reason that the customer chooses to return an item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
},
"itemId": "A String", # Product level item ID. If the returned items are of the same product, they will have the same ID.
"merchantRejectionReason": { # The reason that the merchant chose to reject an item return.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the rejection reason.
},
"merchantReturnReason": { # The reason that merchant chooses to accept a return item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the refund reason. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
},
"product": { # Product data from the time of the order placement.
"brand": "A String", # Brand of the item.
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`"
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for 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.
},
],
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product.
"imageLink": "A String", # URL of an image of the item.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"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.
},
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"targetCountry": "A String", # The CLDR territory code of the target country of the product.
"title": "A String", # The title of the product.
"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.
},
],
},
"refundableAmount": { # Maximum amount that can be refunded for this return item.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs.
"returnShipmentIds": [ # IDs of the return shipments that this return item belongs to.
"A String",
],
"shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support.
"shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
"state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`"
},
],
"returnPricingInfo": { # Information about shipping costs.
"chargeReturnShippingFee": True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.
"maxReturnShippingFee": { # Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableItemsTotalAmount": { # Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"totalRefundedAmount": { # Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
},
"returnShipments": [ # Shipments of the return.
{
"creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format.
"deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format.
"returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" - "`inStore`"
"shipmentId": "A String", # Shipment ID generated by Google.
"shipmentTrackingInfos": [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
{
"carrier": "A String", # The shipping carrier that handles the package. Acceptable values are: - "`boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt`" - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "`googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "`manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "`usps`"
"trackingNumber": "A String", # The tracking number for the package.
},
],
"shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format.
"state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`"
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, returnId, x__xgafv=None)</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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
"creationDate": "A String", # The date of creation of the return, in ISO 8601 format.
"merchantOrderId": "A String", # Merchant defined order ID.
"orderId": "A String", # Google order ID.
"orderReturnId": "A String", # Order return ID generated by Google.
"returnItems": [ # Items of the return.
{
"customerReturnReason": { # The reason that the customer chooses to return an item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
},
"itemId": "A String", # Product level item ID. If the returned items are of the same product, they will have the same ID.
"merchantRejectionReason": { # The reason that the merchant chose to reject an item return.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the rejection reason.
},
"merchantReturnReason": { # The reason that merchant chooses to accept a return item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the refund reason. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
},
"product": { # Product data from the time of the order placement.
"brand": "A String", # Brand of the item.
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`"
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for 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.
},
],
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product.
"imageLink": "A String", # URL of an image of the item.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"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.
},
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"targetCountry": "A String", # The CLDR territory code of the target country of the product.
"title": "A String", # The title of the product.
"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.
},
],
},
"refundableAmount": { # Maximum amount that can be refunded for this return item.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs.
"returnShipmentIds": [ # IDs of the return shipments that this return item belongs to.
"A String",
],
"shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support.
"shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
"state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`"
},
],
"returnPricingInfo": { # Information about shipping costs.
"chargeReturnShippingFee": True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.
"maxReturnShippingFee": { # Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableItemsTotalAmount": { # Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"totalRefundedAmount": { # Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
},
"returnShipments": [ # Shipments of the return.
{
"creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format.
"deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format.
"returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" - "`inStore`"
"shipmentId": "A String", # Shipment ID generated by Google.
"shipmentTrackingInfos": [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
{
"carrier": "A String", # The shipping carrier that handles the package. Acceptable values are: - "`boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt`" - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "`googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "`manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "`usps`"
"trackingNumber": "A String", # The tracking number for the package.
},
],
"shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format.
"state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`"
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, acknowledged=None, createdEndDate=None, createdStartDate=None, googleOrderIds=None, maxResults=None, orderBy=None, pageToken=None, shipmentStates=None, shipmentStatus=None, shipmentTrackingNumbers=None, shipmentTypes=None, x__xgafv=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)
acknowledged: boolean, Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned.
createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format.
createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format.
googleOrderIds: string, Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. (repeated)
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.
orderBy: string, Return the results in the specified order.
Allowed values
RETURN_CREATION_TIME_DESC - Return results in descending order.
RETURN_CREATION_TIME_ASC - Return results in ascending order.
pageToken: string, The token returned by the previous request.
shipmentStates: string, Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states. (repeated)
Allowed values
NEW - Return shipments with `new` state only.
SHIPPED - Return shipments with `shipped` state only.
COMPLETED - Return shipments with `completed` state only.
UNDELIVERABLE - Return shipments with `undeliverable` state only.
PENDING - Return shipments with `pending` state only.
shipmentStatus: string, Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses. (repeated)
Allowed values
NEW - Return shipments with `new` status only.
IN_PROGRESS - Return shipments with `inProgress` status only.
PROCESSED - Return shipments with `processed` status only.
shipmentTrackingNumbers: string, Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. (repeated)
shipmentTypes: string, Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types. (repeated)
Allowed values
BY_MAIL - Return shipments with type `byMail` only.
RETURNLESS - Return shipments with type `returnless` only.
CONTACT_CUSTOMER_SUPPORT - Return shipments with type `contactCustomerSupport` only.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderreturnsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of returns.
"resources": [
{ # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
"creationDate": "A String", # The date of creation of the return, in ISO 8601 format.
"merchantOrderId": "A String", # Merchant defined order ID.
"orderId": "A String", # Google order ID.
"orderReturnId": "A String", # Order return ID generated by Google.
"returnItems": [ # Items of the return.
{
"customerReturnReason": { # The reason that the customer chooses to return an item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
},
"itemId": "A String", # Product level item ID. If the returned items are of the same product, they will have the same ID.
"merchantRejectionReason": { # The reason that the merchant chose to reject an item return.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the rejection reason.
},
"merchantReturnReason": { # The reason that merchant chooses to accept a return item.
"description": "A String", # Description of the reason.
"reasonCode": "A String", # Code of the refund reason. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
},
"product": { # Product data from the time of the order placement.
"brand": "A String", # Brand of the item.
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`"
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for 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.
},
],
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product.
"imageLink": "A String", # URL of an image of the item.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"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.
},
"shownImage": "A String", # URL to the cached image shown to the user when order was placed.
"targetCountry": "A String", # The CLDR territory code of the target country of the product.
"title": "A String", # The title of the product.
"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.
},
],
},
"refundableAmount": { # Maximum amount that can be refunded for this return item.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs.
"returnShipmentIds": [ # IDs of the return shipments that this return item belongs to.
"A String",
],
"shipmentGroupId": "A String", # ID of the original shipment group. Provided for shipments with invoice support.
"shipmentUnitId": "A String", # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
"state": "A String", # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`"
},
],
"returnPricingInfo": { # Information about shipping costs.
"chargeReturnShippingFee": True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.
"maxReturnShippingFee": { # Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableItemsTotalAmount": { # Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"refundableShippingAmount": { # Maximum amount that can be refunded for the original shipping fee.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"totalRefundedAmount": { # Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet.
"priceAmount": { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, "US". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, "France") where price attribute includes tax, this field corresponds to the post-tax value .
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax value, present only for countries where price attribute excludes tax (for example, "US". No tax is referenced as 0 value with the corresponding `currency`.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
},
"returnShipments": [ # Shipments of the return.
{
"creationDate": "A String", # The date of creation of the shipment, in ISO 8601 format.
"deliveryDate": "A String", # The date of delivery of the shipment, in ISO 8601 format.
"returnMethodType": "A String", # Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" - "`inStore`"
"shipmentId": "A String", # Shipment ID generated by Google.
"shipmentTrackingInfos": [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
{
"carrier": "A String", # The shipping carrier that handles the package. Acceptable values are: - "`boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt`" - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "`googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "`manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "`usps`"
"trackingNumber": "A String", # The tracking number for the package.
},
],
"shippingDate": "A String", # The date of shipping of the shipment, in ISO 8601 format.
"state": "A String", # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" - "`pending`"
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
<div class="method">
<code class="details" id="process">process(merchantId, returnId, body=None, x__xgafv=None)</code>
<pre>Processes return 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)
returnId: string, The ID of the return. (required)
body: object, The request body.
The object takes the form of:
{
"fullChargeReturnShippingCost": True or False, # Option to charge the customer return shipping cost.
"operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order return.
"refundShippingFee": { # Refunds for original shipping fee.
"fullRefund": True or False, # If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer through FOP.
"partialRefund": { # If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer.
"priceAmount": { # The pre-tax or post-tax amount to be refunded, depending on the location of the order.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"paymentType": "A String", # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.
"reasonText": "A String", # The explanation of the reason.
"returnRefundReason": "A String", # Code of the refund reason.
},
"returnItems": [ # The list of items to return.
{
"refund": { # Refunds the item.
"fullRefund": True or False, # If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer through FOP.
"partialRefund": { # If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer.
"priceAmount": { # The pre-tax or post-tax amount to be refunded, depending on the location of the order.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxAmount": { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"paymentType": "A String", # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.
"reasonText": "A String", # The explanation of the reason.
"returnRefundReason": "A String", # Code of the refund reason.
},
"reject": { # Rejects the item.
"reason": "A String", # The reason for the return.
"reasonText": "A String", # The explanation of the reason.
},
"returnItemId": "A String", # Unit level ID for the return item. Different units of the same product will have different IDs.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderreturnsProcessResponse`".
}</pre>
</div>
</body></html>
|
