Debian Codegraph @

docs/dyn/content_v2_1.orderreturns.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.orderreturns.html">orderreturns</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="content_v2_1.orderreturns.labels.html">labels()</a></code>
79 </p>
80 <p class="firstline">Returns the labels Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#acknowledge">acknowledge(merchantId, returnId, body=None, x__xgafv=None)</a></code></p>
84 <p class="firstline">Acks an order return in your Merchant Center account.</p>
85 <p class="toc_element">
86 <code><a href="#close">close()</a></code></p>
87 <p class="firstline">Close httplib2 connections.</p>
88 <p class="toc_element">
89 <code><a href="#createorderreturn">createorderreturn(merchantId, body=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Create return in your Merchant Center account.</p>
91 <p class="toc_element">
92 <code><a href="#get">get(merchantId, returnId, x__xgafv=None)</a></code></p>
93 <p class="firstline">Retrieves an order return from your Merchant Center account.</p>
94 <p class="toc_element">
95 <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>
96 <p class="firstline">Lists order returns in your Merchant Center account.</p>
97 <p class="toc_element">
98 <code><a href="#list_next">list_next()</a></code></p>
99 <p class="firstline">Retrieves the next page of results.</p>
100 <p class="toc_element">
101 <code><a href="#process">process(merchantId, returnId, body=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Processes return in your Merchant Center account.</p>
103 <h3>Method Details</h3>
104 <div class="method">
105 <code class="details" id="acknowledge">acknowledge(merchantId, returnId, body=None, x__xgafv=None)</code>
106 <pre>Acks an order return in your Merchant Center account.
107
108 Args:
109 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
110 returnId: string, The ID of the return. (required)
111 body: object, The request body.
112 The object takes the form of:
113
114 {
115 &quot;operationId&quot;: &quot;A String&quot;, # [required] The ID of the operation, unique across all operations for a given order return.
116 }
117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123 Returns:
124 An object of the form:
125
126 {
127 &quot;executionStatus&quot;: &quot;A String&quot;, # The status of the execution. Acceptable values are: - &quot;`duplicate`&quot; - &quot;`executed`&quot;
128 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreturnsAcknowledgeResponse`&quot;.
129 }</pre>
130 </div>
131
132 <div class="method">
133 <code class="details" id="close">close()</code>
134 <pre>Close httplib2 connections.</pre>
135 </div>
136
137 <div class="method">
138 <code class="details" id="createorderreturn">createorderreturn(merchantId, body=None, x__xgafv=None)</code>
139 <pre>Create return in your Merchant Center account.
140
141 Args:
142 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
143 body: object, The request body.
144 The object takes the form of:
145
146 {
147 &quot;lineItems&quot;: [ # The list of line items to return.
148 {
149 &quot;lineItemId&quot;: &quot;A String&quot;, # The ID of the line item. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
150 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
151 &quot;quantity&quot;: 42, # The quantity of this line item.
152 },
153 ],
154 &quot;operationId&quot;: &quot;A String&quot;, # The ID of the operation. Unique across all operations for a given order.
155 &quot;orderId&quot;: &quot;A String&quot;, # The ID of the order.
156 &quot;returnMethodType&quot;: &quot;A String&quot;, # The way of the package being returned.
157 }
158
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164 Returns:
165 An object of the form:
166
167 {
168 &quot;executionStatus&quot;: &quot;A String&quot;, # The status of the execution. Acceptable values are: - &quot;`duplicate`&quot; - &quot;`executed`&quot;
169 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreturnsCreateOrderReturnResponse`&quot;.
170 &quot;orderReturn&quot;: { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not. # Created order return.
171 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the return, in ISO 8601 format.
172 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant defined order ID.
173 &quot;orderId&quot;: &quot;A String&quot;, # Google order ID.
174 &quot;orderReturnId&quot;: &quot;A String&quot;, # Order return ID generated by Google.
175 &quot;returnItems&quot;: [ # Items of the return.
176 {
177 &quot;customerReturnReason&quot;: { # The reason that the customer chooses to return an item.
178 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
179 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the return reason. Acceptable values are: - &quot;`betterPriceFound`&quot; - &quot;`changedMind`&quot; - &quot;`damagedOrDefectiveItem`&quot; - &quot;`didNotMatchDescription`&quot; - &quot;`doesNotFit`&quot; - &quot;`expiredItem`&quot; - &quot;`incorrectItemReceived`&quot; - &quot;`noLongerNeeded`&quot; - &quot;`notSpecified`&quot; - &quot;`orderedWrongItem`&quot; - &quot;`other`&quot; - &quot;`qualityNotExpected`&quot; - &quot;`receivedTooLate`&quot; - &quot;`undeliverable`&quot;
180 },
181 &quot;itemId&quot;: &quot;A String&quot;, # Product level item ID. If the returned items are of the same product, they will have the same ID.
182 &quot;merchantRejectionReason&quot;: { # The reason that the merchant chose to reject an item return.
183 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
184 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the rejection reason.
185 },
186 &quot;merchantReturnReason&quot;: { # The reason that merchant chooses to accept a return item.
187 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
188 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the refund reason. Acceptable values are: - &quot;`adjustment`&quot; - &quot;`autoPostInternal`&quot; - &quot;`autoPostInvalidBillingAddress`&quot; - &quot;`autoPostNoInventory`&quot; - &quot;`autoPostPriceError`&quot; - &quot;`autoPostUndeliverableShippingAddress`&quot; - &quot;`couponAbuse`&quot; - &quot;`courtesyAdjustment`&quot; - &quot;`customerCanceled`&quot; - &quot;`customerDiscretionaryReturn`&quot; - &quot;`customerInitiatedMerchantCancel`&quot; - &quot;`customerSupportRequested`&quot; - &quot;`deliveredLateByCarrier`&quot; - &quot;`deliveredTooLate`&quot; - &quot;`expiredItem`&quot; - &quot;`failToPushOrderGoogleError`&quot; - &quot;`failToPushOrderMerchantError`&quot; - &quot;`failToPushOrderMerchantFulfillmentError`&quot; - &quot;`failToPushOrderToMerchant`&quot; - &quot;`failToPushOrderToMerchantOutOfStock`&quot; - &quot;`feeAdjustment`&quot; - &quot;`invalidCoupon`&quot; - &quot;`lateShipmentCredit`&quot; - &quot;`malformedShippingAddress`&quot; - &quot;`merchantDidNotShipOnTime`&quot; - &quot;`noInventory`&quot; - &quot;`orderTimeout`&quot; - &quot;`other`&quot; - &quot;`paymentAbuse`&quot; - &quot;`paymentDeclined`&quot; - &quot;`priceAdjustment`&quot; - &quot;`priceError`&quot; - &quot;`productArrivedDamaged`&quot; - &quot;`productNotAsDescribed`&quot; - &quot;`promoReallocation`&quot; - &quot;`qualityNotAsExpected`&quot; - &quot;`returnRefundAbuse`&quot; - &quot;`shippingCostAdjustment`&quot; - &quot;`shippingPriceError`&quot; - &quot;`taxAdjustment`&quot; - &quot;`taxError`&quot; - &quot;`undeliverableShippingAddress`&quot; - &quot;`unsupportedPoBoxAddress`&quot; - &quot;`wrongProductShipped`&quot;
189 },
190 &quot;product&quot;: { # Product data from the time of the order placement.
191 &quot;brand&quot;: &quot;A String&quot;, # Brand of the item.
192 &quot;condition&quot;: &quot;A String&quot;, # Condition or state of the item. Acceptable values are: - &quot;`new`&quot; - &quot;`refurbished`&quot; - &quot;`used`&quot;
193 &quot;contentLanguage&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language code for the item.
194 &quot;fees&quot;: [ # Associated fees at order creation time.
195 {
196 &quot;amount&quot;: { # Amount of the fee.
197 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
198 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
199 },
200 &quot;name&quot;: &quot;A String&quot;, # Name of the fee.
201 },
202 ],
203 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number (GTIN) of the item.
204 &quot;id&quot;: &quot;A String&quot;, # The REST ID of the product.
205 &quot;imageLink&quot;: &quot;A String&quot;, # URL of an image of the item.
206 &quot;itemGroupId&quot;: &quot;A String&quot;, # Shared identifier for all variants of the same product.
207 &quot;mpn&quot;: &quot;A String&quot;, # Manufacturer Part Number (MPN) of the item.
208 &quot;offerId&quot;: &quot;A String&quot;, # An identifier of the item.
209 &quot;price&quot;: { # Price of the item.
210 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
211 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
212 },
213 &quot;shownImage&quot;: &quot;A String&quot;, # URL to the cached image shown to the user when order was placed.
214 &quot;targetCountry&quot;: &quot;A String&quot;, # The CLDR territory code of the target country of the product.
215 &quot;title&quot;: &quot;A String&quot;, # The title of the product.
216 &quot;variantAttributes&quot;: [ # 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.
217 {
218 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the variant.
219 &quot;value&quot;: &quot;A String&quot;, # The value for the dimension.
220 },
221 ],
222 },
223 &quot;refundableAmount&quot;: { # Maximum amount that can be refunded for this return item.
224 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
225 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
226 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
227 },
228 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
229 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
230 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
231 },
232 },
233 &quot;returnItemId&quot;: &quot;A String&quot;, # Unit level ID for the return item. Different units of the same product will have different IDs.
234 &quot;returnShipmentIds&quot;: [ # IDs of the return shipments that this return item belongs to.
235 &quot;A String&quot;,
236 ],
237 &quot;shipmentGroupId&quot;: &quot;A String&quot;, # ID of the original shipment group. Provided for shipments with invoice support.
238 &quot;shipmentUnitId&quot;: &quot;A String&quot;, # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
239 &quot;state&quot;: &quot;A String&quot;, # State of the item. Acceptable values are: - &quot;`canceled`&quot; - &quot;`new`&quot; - &quot;`received`&quot; - &quot;`refunded`&quot; - &quot;`rejected`&quot;
240 },
241 ],
242 &quot;returnPricingInfo&quot;: { # Information about shipping costs.
243 &quot;chargeReturnShippingFee&quot;: True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant&#x27;s return policy for the items being returned.
244 &quot;maxReturnShippingFee&quot;: { # Maximum return shipping costs that may be charged to the customer depending on merchant&#x27;s assessment of the return reason and the merchant&#x27;s return policy for the items being returned.
245 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
246 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
247 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
248 },
249 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
250 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
251 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
252 },
253 },
254 &quot;refundableItemsTotalAmount&quot;: { # 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.
255 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
256 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
257 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
258 },
259 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
260 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
261 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
262 },
263 },
264 &quot;refundableShippingAmount&quot;: { # Maximum amount that can be refunded for the original shipping fee.
265 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
266 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
267 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
268 },
269 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
270 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
271 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
272 },
273 },
274 &quot;totalRefundedAmount&quot;: { # 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.
275 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
276 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
277 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
278 },
279 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
280 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
281 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
282 },
283 },
284 },
285 &quot;returnShipments&quot;: [ # Shipments of the return.
286 {
287 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the shipment, in ISO 8601 format.
288 &quot;deliveryDate&quot;: &quot;A String&quot;, # The date of delivery of the shipment, in ISO 8601 format.
289 &quot;returnMethodType&quot;: &quot;A String&quot;, # Type of the return method. Acceptable values are: - &quot;`byMail`&quot; - &quot;`contactCustomerSupport`&quot; - &quot;`returnless`&quot; - &quot;`inStore`&quot;
290 &quot;shipmentId&quot;: &quot;A String&quot;, # Shipment ID generated by Google.
291 &quot;shipmentTrackingInfos&quot;: [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
292 {
293 &quot;carrier&quot;: &quot;A String&quot;, # The shipping carrier that handles the package. Acceptable values are: - &quot;`boxtal`&quot; - &quot;`bpost`&quot; - &quot;`chronopost`&quot; - &quot;`colisPrive`&quot; - &quot;`colissimo`&quot; - &quot;`cxt`&quot; - &quot;`deliv`&quot; - &quot;`dhl`&quot; - &quot;`dpd`&quot; - &quot;`dynamex`&quot; - &quot;`eCourier`&quot; - &quot;`easypost`&quot; - &quot;`efw`&quot; - &quot;`fedex`&quot; - &quot;`fedexSmartpost`&quot; - &quot;`geodis`&quot; - &quot;`gls`&quot; - &quot;`googleCourier`&quot; - &quot;`gsx`&quot; - &quot;`jdLogistics`&quot; - &quot;`laPoste`&quot; - &quot;`lasership`&quot; - &quot;`manual`&quot; - &quot;`mpx`&quot; - &quot;`onTrac`&quot; - &quot;`other`&quot; - &quot;`tnt`&quot; - &quot;`uds`&quot; - &quot;`ups`&quot; - &quot;`usps`&quot;
294 &quot;trackingNumber&quot;: &quot;A String&quot;, # The tracking number for the package.
295 },
296 ],
297 &quot;shippingDate&quot;: &quot;A String&quot;, # The date of shipping of the shipment, in ISO 8601 format.
298 &quot;state&quot;: &quot;A String&quot;, # State of the shipment. Acceptable values are: - &quot;`completed`&quot; - &quot;`new`&quot; - &quot;`shipped`&quot; - &quot;`undeliverable`&quot; - &quot;`pending`&quot;
299 },
300 ],
301 },
302 }</pre>
303 </div>
304
305 <div class="method">
306 <code class="details" id="get">get(merchantId, returnId, x__xgafv=None)</code>
307 <pre>Retrieves an order return from your Merchant Center account.
308
309 Args:
310 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
311 returnId: string, Merchant order return ID generated by Google. (required)
312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317 Returns:
318 An object of the form:
319
320 { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
321 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the return, in ISO 8601 format.
322 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant defined order ID.
323 &quot;orderId&quot;: &quot;A String&quot;, # Google order ID.
324 &quot;orderReturnId&quot;: &quot;A String&quot;, # Order return ID generated by Google.
325 &quot;returnItems&quot;: [ # Items of the return.
326 {
327 &quot;customerReturnReason&quot;: { # The reason that the customer chooses to return an item.
328 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
329 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the return reason. Acceptable values are: - &quot;`betterPriceFound`&quot; - &quot;`changedMind`&quot; - &quot;`damagedOrDefectiveItem`&quot; - &quot;`didNotMatchDescription`&quot; - &quot;`doesNotFit`&quot; - &quot;`expiredItem`&quot; - &quot;`incorrectItemReceived`&quot; - &quot;`noLongerNeeded`&quot; - &quot;`notSpecified`&quot; - &quot;`orderedWrongItem`&quot; - &quot;`other`&quot; - &quot;`qualityNotExpected`&quot; - &quot;`receivedTooLate`&quot; - &quot;`undeliverable`&quot;
330 },
331 &quot;itemId&quot;: &quot;A String&quot;, # Product level item ID. If the returned items are of the same product, they will have the same ID.
332 &quot;merchantRejectionReason&quot;: { # The reason that the merchant chose to reject an item return.
333 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
334 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the rejection reason.
335 },
336 &quot;merchantReturnReason&quot;: { # The reason that merchant chooses to accept a return item.
337 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
338 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the refund reason. Acceptable values are: - &quot;`adjustment`&quot; - &quot;`autoPostInternal`&quot; - &quot;`autoPostInvalidBillingAddress`&quot; - &quot;`autoPostNoInventory`&quot; - &quot;`autoPostPriceError`&quot; - &quot;`autoPostUndeliverableShippingAddress`&quot; - &quot;`couponAbuse`&quot; - &quot;`courtesyAdjustment`&quot; - &quot;`customerCanceled`&quot; - &quot;`customerDiscretionaryReturn`&quot; - &quot;`customerInitiatedMerchantCancel`&quot; - &quot;`customerSupportRequested`&quot; - &quot;`deliveredLateByCarrier`&quot; - &quot;`deliveredTooLate`&quot; - &quot;`expiredItem`&quot; - &quot;`failToPushOrderGoogleError`&quot; - &quot;`failToPushOrderMerchantError`&quot; - &quot;`failToPushOrderMerchantFulfillmentError`&quot; - &quot;`failToPushOrderToMerchant`&quot; - &quot;`failToPushOrderToMerchantOutOfStock`&quot; - &quot;`feeAdjustment`&quot; - &quot;`invalidCoupon`&quot; - &quot;`lateShipmentCredit`&quot; - &quot;`malformedShippingAddress`&quot; - &quot;`merchantDidNotShipOnTime`&quot; - &quot;`noInventory`&quot; - &quot;`orderTimeout`&quot; - &quot;`other`&quot; - &quot;`paymentAbuse`&quot; - &quot;`paymentDeclined`&quot; - &quot;`priceAdjustment`&quot; - &quot;`priceError`&quot; - &quot;`productArrivedDamaged`&quot; - &quot;`productNotAsDescribed`&quot; - &quot;`promoReallocation`&quot; - &quot;`qualityNotAsExpected`&quot; - &quot;`returnRefundAbuse`&quot; - &quot;`shippingCostAdjustment`&quot; - &quot;`shippingPriceError`&quot; - &quot;`taxAdjustment`&quot; - &quot;`taxError`&quot; - &quot;`undeliverableShippingAddress`&quot; - &quot;`unsupportedPoBoxAddress`&quot; - &quot;`wrongProductShipped`&quot;
339 },
340 &quot;product&quot;: { # Product data from the time of the order placement.
341 &quot;brand&quot;: &quot;A String&quot;, # Brand of the item.
342 &quot;condition&quot;: &quot;A String&quot;, # Condition or state of the item. Acceptable values are: - &quot;`new`&quot; - &quot;`refurbished`&quot; - &quot;`used`&quot;
343 &quot;contentLanguage&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language code for the item.
344 &quot;fees&quot;: [ # Associated fees at order creation time.
345 {
346 &quot;amount&quot;: { # Amount of the fee.
347 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
348 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
349 },
350 &quot;name&quot;: &quot;A String&quot;, # Name of the fee.
351 },
352 ],
353 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number (GTIN) of the item.
354 &quot;id&quot;: &quot;A String&quot;, # The REST ID of the product.
355 &quot;imageLink&quot;: &quot;A String&quot;, # URL of an image of the item.
356 &quot;itemGroupId&quot;: &quot;A String&quot;, # Shared identifier for all variants of the same product.
357 &quot;mpn&quot;: &quot;A String&quot;, # Manufacturer Part Number (MPN) of the item.
358 &quot;offerId&quot;: &quot;A String&quot;, # An identifier of the item.
359 &quot;price&quot;: { # Price of the item.
360 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
361 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
362 },
363 &quot;shownImage&quot;: &quot;A String&quot;, # URL to the cached image shown to the user when order was placed.
364 &quot;targetCountry&quot;: &quot;A String&quot;, # The CLDR territory code of the target country of the product.
365 &quot;title&quot;: &quot;A String&quot;, # The title of the product.
366 &quot;variantAttributes&quot;: [ # 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.
367 {
368 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the variant.
369 &quot;value&quot;: &quot;A String&quot;, # The value for the dimension.
370 },
371 ],
372 },
373 &quot;refundableAmount&quot;: { # Maximum amount that can be refunded for this return item.
374 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
375 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
376 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
377 },
378 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
379 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
380 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
381 },
382 },
383 &quot;returnItemId&quot;: &quot;A String&quot;, # Unit level ID for the return item. Different units of the same product will have different IDs.
384 &quot;returnShipmentIds&quot;: [ # IDs of the return shipments that this return item belongs to.
385 &quot;A String&quot;,
386 ],
387 &quot;shipmentGroupId&quot;: &quot;A String&quot;, # ID of the original shipment group. Provided for shipments with invoice support.
388 &quot;shipmentUnitId&quot;: &quot;A String&quot;, # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
389 &quot;state&quot;: &quot;A String&quot;, # State of the item. Acceptable values are: - &quot;`canceled`&quot; - &quot;`new`&quot; - &quot;`received`&quot; - &quot;`refunded`&quot; - &quot;`rejected`&quot;
390 },
391 ],
392 &quot;returnPricingInfo&quot;: { # Information about shipping costs.
393 &quot;chargeReturnShippingFee&quot;: True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant&#x27;s return policy for the items being returned.
394 &quot;maxReturnShippingFee&quot;: { # Maximum return shipping costs that may be charged to the customer depending on merchant&#x27;s assessment of the return reason and the merchant&#x27;s return policy for the items being returned.
395 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
396 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
397 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
398 },
399 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
400 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
401 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
402 },
403 },
404 &quot;refundableItemsTotalAmount&quot;: { # 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.
405 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
406 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
407 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
408 },
409 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
410 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
411 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
412 },
413 },
414 &quot;refundableShippingAmount&quot;: { # Maximum amount that can be refunded for the original shipping fee.
415 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
416 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
417 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
418 },
419 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
420 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
421 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
422 },
423 },
424 &quot;totalRefundedAmount&quot;: { # 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.
425 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
426 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
427 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
428 },
429 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
430 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
431 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
432 },
433 },
434 },
435 &quot;returnShipments&quot;: [ # Shipments of the return.
436 {
437 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the shipment, in ISO 8601 format.
438 &quot;deliveryDate&quot;: &quot;A String&quot;, # The date of delivery of the shipment, in ISO 8601 format.
439 &quot;returnMethodType&quot;: &quot;A String&quot;, # Type of the return method. Acceptable values are: - &quot;`byMail`&quot; - &quot;`contactCustomerSupport`&quot; - &quot;`returnless`&quot; - &quot;`inStore`&quot;
440 &quot;shipmentId&quot;: &quot;A String&quot;, # Shipment ID generated by Google.
441 &quot;shipmentTrackingInfos&quot;: [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
442 {
443 &quot;carrier&quot;: &quot;A String&quot;, # The shipping carrier that handles the package. Acceptable values are: - &quot;`boxtal`&quot; - &quot;`bpost`&quot; - &quot;`chronopost`&quot; - &quot;`colisPrive`&quot; - &quot;`colissimo`&quot; - &quot;`cxt`&quot; - &quot;`deliv`&quot; - &quot;`dhl`&quot; - &quot;`dpd`&quot; - &quot;`dynamex`&quot; - &quot;`eCourier`&quot; - &quot;`easypost`&quot; - &quot;`efw`&quot; - &quot;`fedex`&quot; - &quot;`fedexSmartpost`&quot; - &quot;`geodis`&quot; - &quot;`gls`&quot; - &quot;`googleCourier`&quot; - &quot;`gsx`&quot; - &quot;`jdLogistics`&quot; - &quot;`laPoste`&quot; - &quot;`lasership`&quot; - &quot;`manual`&quot; - &quot;`mpx`&quot; - &quot;`onTrac`&quot; - &quot;`other`&quot; - &quot;`tnt`&quot; - &quot;`uds`&quot; - &quot;`ups`&quot; - &quot;`usps`&quot;
444 &quot;trackingNumber&quot;: &quot;A String&quot;, # The tracking number for the package.
445 },
446 ],
447 &quot;shippingDate&quot;: &quot;A String&quot;, # The date of shipping of the shipment, in ISO 8601 format.
448 &quot;state&quot;: &quot;A String&quot;, # State of the shipment. Acceptable values are: - &quot;`completed`&quot; - &quot;`new`&quot; - &quot;`shipped`&quot; - &quot;`undeliverable`&quot; - &quot;`pending`&quot;
449 },
450 ],
451 }</pre>
452 </div>
453
454 <div class="method">
455 <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>
456 <pre>Lists order returns in your Merchant Center account.
457
458 Args:
459 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
460 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.
461 createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format.
462 createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format.
463 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)
464 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.
465 orderBy: string, Return the results in the specified order.
466 Allowed values
467 RETURN_CREATION_TIME_DESC - Return results in descending order.
468 RETURN_CREATION_TIME_ASC - Return results in ascending order.
469 pageToken: string, The token returned by the previous request.
470 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)
471 Allowed values
472 NEW - Return shipments with `new` state only.
473 SHIPPED - Return shipments with `shipped` state only.
474 COMPLETED - Return shipments with `completed` state only.
475 UNDELIVERABLE - Return shipments with `undeliverable` state only.
476 PENDING - Return shipments with `pending` state only.
477 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)
478 Allowed values
479 NEW - Return shipments with `new` status only.
480 IN_PROGRESS - Return shipments with `inProgress` status only.
481 PROCESSED - Return shipments with `processed` status only.
482 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)
483 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)
484 Allowed values
485 BY_MAIL - Return shipments with type `byMail` only.
486 RETURNLESS - Return shipments with type `returnless` only.
487 CONTACT_CUSTOMER_SUPPORT - Return shipments with type `contactCustomerSupport` only.
488 x__xgafv: string, V1 error format.
489 Allowed values
490 1 - v1 error format
491 2 - v2 error format
492
493 Returns:
494 An object of the form:
495
496 {
497 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreturnsListResponse`&quot;.
498 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of returns.
499 &quot;resources&quot;: [
500 { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
501 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the return, in ISO 8601 format.
502 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant defined order ID.
503 &quot;orderId&quot;: &quot;A String&quot;, # Google order ID.
504 &quot;orderReturnId&quot;: &quot;A String&quot;, # Order return ID generated by Google.
505 &quot;returnItems&quot;: [ # Items of the return.
506 {
507 &quot;customerReturnReason&quot;: { # The reason that the customer chooses to return an item.
508 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
509 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the return reason. Acceptable values are: - &quot;`betterPriceFound`&quot; - &quot;`changedMind`&quot; - &quot;`damagedOrDefectiveItem`&quot; - &quot;`didNotMatchDescription`&quot; - &quot;`doesNotFit`&quot; - &quot;`expiredItem`&quot; - &quot;`incorrectItemReceived`&quot; - &quot;`noLongerNeeded`&quot; - &quot;`notSpecified`&quot; - &quot;`orderedWrongItem`&quot; - &quot;`other`&quot; - &quot;`qualityNotExpected`&quot; - &quot;`receivedTooLate`&quot; - &quot;`undeliverable`&quot;
510 },
511 &quot;itemId&quot;: &quot;A String&quot;, # Product level item ID. If the returned items are of the same product, they will have the same ID.
512 &quot;merchantRejectionReason&quot;: { # The reason that the merchant chose to reject an item return.
513 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
514 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the rejection reason.
515 },
516 &quot;merchantReturnReason&quot;: { # The reason that merchant chooses to accept a return item.
517 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
518 &quot;reasonCode&quot;: &quot;A String&quot;, # Code of the refund reason. Acceptable values are: - &quot;`adjustment`&quot; - &quot;`autoPostInternal`&quot; - &quot;`autoPostInvalidBillingAddress`&quot; - &quot;`autoPostNoInventory`&quot; - &quot;`autoPostPriceError`&quot; - &quot;`autoPostUndeliverableShippingAddress`&quot; - &quot;`couponAbuse`&quot; - &quot;`courtesyAdjustment`&quot; - &quot;`customerCanceled`&quot; - &quot;`customerDiscretionaryReturn`&quot; - &quot;`customerInitiatedMerchantCancel`&quot; - &quot;`customerSupportRequested`&quot; - &quot;`deliveredLateByCarrier`&quot; - &quot;`deliveredTooLate`&quot; - &quot;`expiredItem`&quot; - &quot;`failToPushOrderGoogleError`&quot; - &quot;`failToPushOrderMerchantError`&quot; - &quot;`failToPushOrderMerchantFulfillmentError`&quot; - &quot;`failToPushOrderToMerchant`&quot; - &quot;`failToPushOrderToMerchantOutOfStock`&quot; - &quot;`feeAdjustment`&quot; - &quot;`invalidCoupon`&quot; - &quot;`lateShipmentCredit`&quot; - &quot;`malformedShippingAddress`&quot; - &quot;`merchantDidNotShipOnTime`&quot; - &quot;`noInventory`&quot; - &quot;`orderTimeout`&quot; - &quot;`other`&quot; - &quot;`paymentAbuse`&quot; - &quot;`paymentDeclined`&quot; - &quot;`priceAdjustment`&quot; - &quot;`priceError`&quot; - &quot;`productArrivedDamaged`&quot; - &quot;`productNotAsDescribed`&quot; - &quot;`promoReallocation`&quot; - &quot;`qualityNotAsExpected`&quot; - &quot;`returnRefundAbuse`&quot; - &quot;`shippingCostAdjustment`&quot; - &quot;`shippingPriceError`&quot; - &quot;`taxAdjustment`&quot; - &quot;`taxError`&quot; - &quot;`undeliverableShippingAddress`&quot; - &quot;`unsupportedPoBoxAddress`&quot; - &quot;`wrongProductShipped`&quot;
519 },
520 &quot;product&quot;: { # Product data from the time of the order placement.
521 &quot;brand&quot;: &quot;A String&quot;, # Brand of the item.
522 &quot;condition&quot;: &quot;A String&quot;, # Condition or state of the item. Acceptable values are: - &quot;`new`&quot; - &quot;`refurbished`&quot; - &quot;`used`&quot;
523 &quot;contentLanguage&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language code for the item.
524 &quot;fees&quot;: [ # Associated fees at order creation time.
525 {
526 &quot;amount&quot;: { # Amount of the fee.
527 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
528 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
529 },
530 &quot;name&quot;: &quot;A String&quot;, # Name of the fee.
531 },
532 ],
533 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number (GTIN) of the item.
534 &quot;id&quot;: &quot;A String&quot;, # The REST ID of the product.
535 &quot;imageLink&quot;: &quot;A String&quot;, # URL of an image of the item.
536 &quot;itemGroupId&quot;: &quot;A String&quot;, # Shared identifier for all variants of the same product.
537 &quot;mpn&quot;: &quot;A String&quot;, # Manufacturer Part Number (MPN) of the item.
538 &quot;offerId&quot;: &quot;A String&quot;, # An identifier of the item.
539 &quot;price&quot;: { # Price of the item.
540 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
541 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
542 },
543 &quot;shownImage&quot;: &quot;A String&quot;, # URL to the cached image shown to the user when order was placed.
544 &quot;targetCountry&quot;: &quot;A String&quot;, # The CLDR territory code of the target country of the product.
545 &quot;title&quot;: &quot;A String&quot;, # The title of the product.
546 &quot;variantAttributes&quot;: [ # 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.
547 {
548 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the variant.
549 &quot;value&quot;: &quot;A String&quot;, # The value for the dimension.
550 },
551 ],
552 },
553 &quot;refundableAmount&quot;: { # Maximum amount that can be refunded for this return item.
554 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
555 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
556 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
557 },
558 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
559 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
560 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
561 },
562 },
563 &quot;returnItemId&quot;: &quot;A String&quot;, # Unit level ID for the return item. Different units of the same product will have different IDs.
564 &quot;returnShipmentIds&quot;: [ # IDs of the return shipments that this return item belongs to.
565 &quot;A String&quot;,
566 ],
567 &quot;shipmentGroupId&quot;: &quot;A String&quot;, # ID of the original shipment group. Provided for shipments with invoice support.
568 &quot;shipmentUnitId&quot;: &quot;A String&quot;, # ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
569 &quot;state&quot;: &quot;A String&quot;, # State of the item. Acceptable values are: - &quot;`canceled`&quot; - &quot;`new`&quot; - &quot;`received`&quot; - &quot;`refunded`&quot; - &quot;`rejected`&quot;
570 },
571 ],
572 &quot;returnPricingInfo&quot;: { # Information about shipping costs.
573 &quot;chargeReturnShippingFee&quot;: True or False, # Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant&#x27;s return policy for the items being returned.
574 &quot;maxReturnShippingFee&quot;: { # Maximum return shipping costs that may be charged to the customer depending on merchant&#x27;s assessment of the return reason and the merchant&#x27;s return policy for the items being returned.
575 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
576 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
577 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
578 },
579 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
580 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
581 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
582 },
583 },
584 &quot;refundableItemsTotalAmount&quot;: { # 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.
585 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
586 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
587 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
588 },
589 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
590 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
591 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
592 },
593 },
594 &quot;refundableShippingAmount&quot;: { # Maximum amount that can be refunded for the original shipping fee.
595 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
596 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
597 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
598 },
599 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
600 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
601 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
602 },
603 },
604 &quot;totalRefundedAmount&quot;: { # 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.
605 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depends on the location of the order. - For countries (for example, &quot;US&quot;. where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, &quot;France&quot;) where price attribute includes tax, this field corresponds to the post-tax value .
606 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
607 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
608 },
609 &quot;taxAmount&quot;: { # Tax value, present only for countries where price attribute excludes tax (for example, &quot;US&quot;. No tax is referenced as 0 value with the corresponding `currency`.
610 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
611 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
612 },
613 },
614 },
615 &quot;returnShipments&quot;: [ # Shipments of the return.
616 {
617 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the shipment, in ISO 8601 format.
618 &quot;deliveryDate&quot;: &quot;A String&quot;, # The date of delivery of the shipment, in ISO 8601 format.
619 &quot;returnMethodType&quot;: &quot;A String&quot;, # Type of the return method. Acceptable values are: - &quot;`byMail`&quot; - &quot;`contactCustomerSupport`&quot; - &quot;`returnless`&quot; - &quot;`inStore`&quot;
620 &quot;shipmentId&quot;: &quot;A String&quot;, # Shipment ID generated by Google.
621 &quot;shipmentTrackingInfos&quot;: [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
622 {
623 &quot;carrier&quot;: &quot;A String&quot;, # The shipping carrier that handles the package. Acceptable values are: - &quot;`boxtal`&quot; - &quot;`bpost`&quot; - &quot;`chronopost`&quot; - &quot;`colisPrive`&quot; - &quot;`colissimo`&quot; - &quot;`cxt`&quot; - &quot;`deliv`&quot; - &quot;`dhl`&quot; - &quot;`dpd`&quot; - &quot;`dynamex`&quot; - &quot;`eCourier`&quot; - &quot;`easypost`&quot; - &quot;`efw`&quot; - &quot;`fedex`&quot; - &quot;`fedexSmartpost`&quot; - &quot;`geodis`&quot; - &quot;`gls`&quot; - &quot;`googleCourier`&quot; - &quot;`gsx`&quot; - &quot;`jdLogistics`&quot; - &quot;`laPoste`&quot; - &quot;`lasership`&quot; - &quot;`manual`&quot; - &quot;`mpx`&quot; - &quot;`onTrac`&quot; - &quot;`other`&quot; - &quot;`tnt`&quot; - &quot;`uds`&quot; - &quot;`ups`&quot; - &quot;`usps`&quot;
624 &quot;trackingNumber&quot;: &quot;A String&quot;, # The tracking number for the package.
625 },
626 ],
627 &quot;shippingDate&quot;: &quot;A String&quot;, # The date of shipping of the shipment, in ISO 8601 format.
628 &quot;state&quot;: &quot;A String&quot;, # State of the shipment. Acceptable values are: - &quot;`completed`&quot; - &quot;`new`&quot; - &quot;`shipped`&quot; - &quot;`undeliverable`&quot; - &quot;`pending`&quot;
629 },
630 ],
631 },
632 ],
633 }</pre>
634 </div>
635
636 <div class="method">
637 <code class="details" id="list_next">list_next()</code>
638 <pre>Retrieves the next page of results.
639
640 Args:
641 previous_request: The request for the previous page. (required)
642 previous_response: The response from the request for the previous page. (required)
643
644 Returns:
645 A request object that you can call &#x27;execute()&#x27; on to request the next
646 page. Returns None if there are no more items in the collection.
647 </pre>
648 </div>
649
650 <div class="method">
651 <code class="details" id="process">process(merchantId, returnId, body=None, x__xgafv=None)</code>
652 <pre>Processes return in your Merchant Center account.
653
654 Args:
655 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
656 returnId: string, The ID of the return. (required)
657 body: object, The request body.
658 The object takes the form of:
659
660 {
661 &quot;fullChargeReturnShippingCost&quot;: True or False, # Option to charge the customer return shipping cost.
662 &quot;operationId&quot;: &quot;A String&quot;, # [required] The ID of the operation, unique across all operations for a given order return.
663 &quot;refundShippingFee&quot;: { # Refunds for original shipping fee.
664 &quot;fullRefund&quot;: 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.
665 &quot;partialRefund&quot;: { # 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.
666 &quot;priceAmount&quot;: { # The pre-tax or post-tax amount to be refunded, depending on the location of the order.
667 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
668 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
669 },
670 &quot;taxAmount&quot;: { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order.
671 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
672 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
673 },
674 },
675 &quot;paymentType&quot;: &quot;A String&quot;, # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.
676 &quot;reasonText&quot;: &quot;A String&quot;, # The explanation of the reason.
677 &quot;returnRefundReason&quot;: &quot;A String&quot;, # Code of the refund reason.
678 },
679 &quot;returnItems&quot;: [ # The list of items to return.
680 {
681 &quot;refund&quot;: { # Refunds the item.
682 &quot;fullRefund&quot;: 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.
683 &quot;partialRefund&quot;: { # 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.
684 &quot;priceAmount&quot;: { # The pre-tax or post-tax amount to be refunded, depending on the location of the order.
685 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
686 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
687 },
688 &quot;taxAmount&quot;: { # Tax amount to be refunded. Note: This has different meaning depending on the location of the order.
689 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
690 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
691 },
692 },
693 &quot;paymentType&quot;: &quot;A String&quot;, # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.
694 &quot;reasonText&quot;: &quot;A String&quot;, # The explanation of the reason.
695 &quot;returnRefundReason&quot;: &quot;A String&quot;, # Code of the refund reason.
696 },
697 &quot;reject&quot;: { # Rejects the item.
698 &quot;reason&quot;: &quot;A String&quot;, # The reason for the return.
699 &quot;reasonText&quot;: &quot;A String&quot;, # The explanation of the reason.
700 },
701 &quot;returnItemId&quot;: &quot;A String&quot;, # Unit level ID for the return item. Different units of the same product will have different IDs.
702 },
703 ],
704 }
705
706 x__xgafv: string, V1 error format.
707 Allowed values
708 1 - v1 error format
709 2 - v2 error format
710
711 Returns:
712 An object of the form:
713
714 {
715 &quot;executionStatus&quot;: &quot;A String&quot;, # The status of the execution. Acceptable values are: - &quot;`duplicate`&quot; - &quot;`executed`&quot;
716 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreturnsProcessResponse`&quot;.
717 }</pre>
718 </div>
719
720 </body></html>