Debian Codegraph @

docs/dyn/content_v2.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.html">Content API for Shopping</a> . <a href="content_v2.orderreturns.html">orderreturns</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(merchantId, returnId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves an order return from your Merchant Center account.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(merchantId, createdEndDate=None, createdStartDate=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists order returns in your Merchant Center account.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(merchantId, returnId, x__xgafv=None)</code>
97 <pre>Retrieves an order return from your Merchant Center account.
98
99 Args:
100 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
101 returnId: string, Merchant order return ID generated by Google. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
111 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the return, in ISO 8601 format.
112 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant defined order ID.
113 &quot;orderId&quot;: &quot;A String&quot;, # Google order ID.
114 &quot;orderReturnId&quot;: &quot;A String&quot;, # Order return ID generated by Google.
115 &quot;returnItems&quot;: [ # Items of the return.
116 {
117 &quot;customerReturnReason&quot;: { # The reason that the customer chooses to return an item.
118 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
119 &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;
120 },
121 &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.
122 &quot;merchantReturnReason&quot;: { # The reason that merchant chooses to accept a return item.
123 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
124 &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;
125 },
126 &quot;product&quot;: { # Product data from the time of the order placement.
127 &quot;brand&quot;: &quot;A String&quot;, # Brand of the item.
128 &quot;channel&quot;: &quot;A String&quot;, # The item&#x27;s channel (online or local). Acceptable values are: - &quot;`local`&quot; - &quot;`online`&quot;
129 &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;
130 &quot;contentLanguage&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language code for the item.
131 &quot;fees&quot;: [ # Associated fees at order creation time.
132 {
133 &quot;amount&quot;: { # Amount of the fee.
134 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
135 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
136 },
137 &quot;name&quot;: &quot;A String&quot;, # Name of the fee.
138 },
139 ],
140 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number (GTIN) of the item.
141 &quot;id&quot;: &quot;A String&quot;, # The REST ID of the product.
142 &quot;imageLink&quot;: &quot;A String&quot;, # URL of an image of the item.
143 &quot;itemGroupId&quot;: &quot;A String&quot;, # Shared identifier for all variants of the same product.
144 &quot;mpn&quot;: &quot;A String&quot;, # Manufacturer Part Number (MPN) of the item.
145 &quot;offerId&quot;: &quot;A String&quot;, # An identifier of the item.
146 &quot;price&quot;: { # Price of the item.
147 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
148 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
149 },
150 &quot;shownImage&quot;: &quot;A String&quot;, # URL to the cached image shown to the user when order was placed.
151 &quot;targetCountry&quot;: &quot;A String&quot;, # The CLDR territory // code of the target country of the product.
152 &quot;title&quot;: &quot;A String&quot;, # The title of the product.
153 &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.
154 {
155 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the variant.
156 &quot;value&quot;: &quot;A String&quot;, # The value for the dimension.
157 },
158 ],
159 },
160 &quot;returnShipmentIds&quot;: [ # IDs of the return shipments that this return item belongs to.
161 &quot;A String&quot;,
162 ],
163 &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;
164 },
165 ],
166 &quot;returnShipments&quot;: [ # Shipments of the return.
167 {
168 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the shipment, in ISO 8601 format.
169 &quot;deliveryDate&quot;: &quot;A String&quot;, # The date of delivery of the shipment, in ISO 8601 format.
170 &quot;returnMethodType&quot;: &quot;A String&quot;, # Type of the return method. Acceptable values are: - &quot;`byMail`&quot; - &quot;`contactCustomerSupport`&quot; - &quot;`returnless`&quot;
171 &quot;shipmentId&quot;: &quot;A String&quot;, # Shipment ID generated by Google.
172 &quot;shipmentTrackingInfos&quot;: [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
173 {
174 &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;
175 &quot;trackingNumber&quot;: &quot;A String&quot;, # The tracking number for the package.
176 },
177 ],
178 &quot;shippingDate&quot;: &quot;A String&quot;, # The date of shipping of the shipment, in ISO 8601 format.
179 &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;
180 },
181 ],
182 }</pre>
183 </div>
184
185 <div class="method">
186 <code class="details" id="list">list(merchantId, createdEndDate=None, createdStartDate=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
187 <pre>Lists order returns in your Merchant Center account.
188
189 Args:
190 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
191 createdEndDate: string, Obtains order returns created before this date (inclusively), in ISO 8601 format.
192 createdStartDate: string, Obtains order returns created after this date (inclusively), in ISO 8601 format.
193 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.
194 orderBy: string, Return the results in the specified order.
195 Allowed values
196 RETURN_CREATION_TIME_DESC -
197 RETURN_CREATION_TIME_ASC -
198 pageToken: string, The token returned by the previous request.
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204 Returns:
205 An object of the form:
206
207 {
208 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#orderreturnsListResponse&quot;.
209 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of returns.
210 &quot;resources&quot;: [
211 { # Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
212 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the return, in ISO 8601 format.
213 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant defined order ID.
214 &quot;orderId&quot;: &quot;A String&quot;, # Google order ID.
215 &quot;orderReturnId&quot;: &quot;A String&quot;, # Order return ID generated by Google.
216 &quot;returnItems&quot;: [ # Items of the return.
217 {
218 &quot;customerReturnReason&quot;: { # The reason that the customer chooses to return an item.
219 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
220 &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;
221 },
222 &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.
223 &quot;merchantReturnReason&quot;: { # The reason that merchant chooses to accept a return item.
224 &quot;description&quot;: &quot;A String&quot;, # Description of the reason.
225 &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;
226 },
227 &quot;product&quot;: { # Product data from the time of the order placement.
228 &quot;brand&quot;: &quot;A String&quot;, # Brand of the item.
229 &quot;channel&quot;: &quot;A String&quot;, # The item&#x27;s channel (online or local). Acceptable values are: - &quot;`local`&quot; - &quot;`online`&quot;
230 &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;
231 &quot;contentLanguage&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language code for the item.
232 &quot;fees&quot;: [ # Associated fees at order creation time.
233 {
234 &quot;amount&quot;: { # Amount of the fee.
235 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
236 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
237 },
238 &quot;name&quot;: &quot;A String&quot;, # Name of the fee.
239 },
240 ],
241 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number (GTIN) of the item.
242 &quot;id&quot;: &quot;A String&quot;, # The REST ID of the product.
243 &quot;imageLink&quot;: &quot;A String&quot;, # URL of an image of the item.
244 &quot;itemGroupId&quot;: &quot;A String&quot;, # Shared identifier for all variants of the same product.
245 &quot;mpn&quot;: &quot;A String&quot;, # Manufacturer Part Number (MPN) of the item.
246 &quot;offerId&quot;: &quot;A String&quot;, # An identifier of the item.
247 &quot;price&quot;: { # Price of the item.
248 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
249 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
250 },
251 &quot;shownImage&quot;: &quot;A String&quot;, # URL to the cached image shown to the user when order was placed.
252 &quot;targetCountry&quot;: &quot;A String&quot;, # The CLDR territory // code of the target country of the product.
253 &quot;title&quot;: &quot;A String&quot;, # The title of the product.
254 &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.
255 {
256 &quot;dimension&quot;: &quot;A String&quot;, # The dimension of the variant.
257 &quot;value&quot;: &quot;A String&quot;, # The value for the dimension.
258 },
259 ],
260 },
261 &quot;returnShipmentIds&quot;: [ # IDs of the return shipments that this return item belongs to.
262 &quot;A String&quot;,
263 ],
264 &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;
265 },
266 ],
267 &quot;returnShipments&quot;: [ # Shipments of the return.
268 {
269 &quot;creationDate&quot;: &quot;A String&quot;, # The date of creation of the shipment, in ISO 8601 format.
270 &quot;deliveryDate&quot;: &quot;A String&quot;, # The date of delivery of the shipment, in ISO 8601 format.
271 &quot;returnMethodType&quot;: &quot;A String&quot;, # Type of the return method. Acceptable values are: - &quot;`byMail`&quot; - &quot;`contactCustomerSupport`&quot; - &quot;`returnless`&quot;
272 &quot;shipmentId&quot;: &quot;A String&quot;, # Shipment ID generated by Google.
273 &quot;shipmentTrackingInfos&quot;: [ # Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
274 {
275 &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;
276 &quot;trackingNumber&quot;: &quot;A String&quot;, # The tracking number for the package.
277 },
278 ],
279 &quot;shippingDate&quot;: &quot;A String&quot;, # The date of shipping of the shipment, in ISO 8601 format.
280 &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;
281 },
282 ],
283 },
284 ],
285 }</pre>
286 </div>
287
288 <div class="method">
289 <code class="details" id="list_next">list_next()</code>
290 <pre>Retrieves the next page of results.
291
292 Args:
293 previous_request: The request for the previous page. (required)
294 previous_response: The response from the request for the previous page. (required)
295
296 Returns:
297 A request object that you can call &#x27;execute()&#x27; on to request the next
298 page. Returns None if there are no more items in the collection.
299 </pre>
300 </div>
301
302 </body></html>