Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / content_v2_1.orders.html
blob: 4ddfc87db645c042a761465f4823cc667cb84600 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.orders.html">orders</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#acknowledge">acknowledge(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Marks an order as acknowledged.</p>
80<p class="toc_element">
81 <code><a href="#advancetestorder">advancetestorder(merchantId, orderId)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]82<p class="firstline">Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#cancel">cancel(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Cancels all line items in an order, making a full refund.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#cancellineitem">cancellineitem(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Cancels a line item, making a full refund.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#canceltestorderbycustomer">canceltestorderbycustomer(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Sandbox only. Cancels a test order for customer-initiated cancellation.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#createtestorder">createtestorder(merchantId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Sandbox only. Creates a test order.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#createtestreturn">createtestreturn(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Sandbox only. Creates a test return.</p>
98<p class="toc_element">
99 <code><a href="#get">get(merchantId, orderId)</a></code></p>
100<p class="firstline">Retrieves an order from your Merchant Center account.</p>
101<p class="toc_element">
102 <code><a href="#getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</a></code></p>
103<p class="firstline">Retrieves an order using merchant order ID.</p>
104<p class="toc_element">
105 <code><a href="#gettestordertemplate">gettestordertemplate(merchantId, templateName, country=None)</a></code></p>
106<p class="firstline">Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#instorerefundlineitem">instorerefundlineitem(merchantId, orderId, body=None)</a></code></p>
109<p class="firstline">Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110<p class="toc_element">
111 <code><a href="#list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</a></code></p>
112<p class="firstline">Lists the orders in your Merchant Center account.</p>
113<p class="toc_element">
114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
115<p class="firstline">Retrieves the next page of results.</p>
116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 <code><a href="#rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118<p class="firstline">Rejects return on an line item.</p>
119<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 <code><a href="#returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121<p class="firstline">Returns and refunds a line item. Note that this method can only be called on fully shipped orders.</p>
122<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]123 <code><a href="#setlineitemmetadata">setlineitemmetadata(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124<p class="firstline">Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.</p>
125<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 <code><a href="#shiplineitems">shiplineitems(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127<p class="firstline">Marks line item(s) as shipped.</p>
128<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 <code><a href="#updatelineitemshippingdetails">updatelineitemshippingdetails(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130<p class="firstline">Updates ship by and delivery by dates for a line item.</p>
131<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 <code><a href="#updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133<p class="firstline">Updates the merchant order ID for a given order.</p>
134<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 <code><a href="#updateshipment">updateshipment(merchantId, orderId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136<p class="firstline">Updates a shipment's status, carrier, and/or tracking ID.</p>
137<h3>Method Details</h3>
138<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139 <code class="details" id="acknowledge">acknowledge(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 <pre>Marks an order as acknowledged.
141
142Args:
143 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
144 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 The object takes the form of:
147
148{
149 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
150 }
151
152
153Returns:
154 An object of the form:
155
156 {
157 "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
158 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 #
160 # Acceptable values are:
161 # - "`duplicate`"
162 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="advancetestorder">advancetestorder(merchantId, orderId)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 <pre>Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169
170Args:
171 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
172 orderId: string, The ID of the test order to modify. (required)
173
174Returns:
175 An object of the form:
176
177 {
178 "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
179 }</pre>
180</div>
181
182<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 <code class="details" id="cancel">cancel(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 <pre>Cancels all line items in an order, making a full refund.
185
186Args:
187 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
188 orderId: string, The ID of the order to cancel. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 The object takes the form of:
191
192{
193 "reason": "A String", # The reason for the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 #
195 # Acceptable values are:
196 # - "`customerInitiatedCancel`"
197 # - "`invalidCoupon`"
198 # - "`malformedShippingAddress`"
199 # - "`noInventory`"
200 # - "`other`"
201 # - "`priceError`"
202 # - "`shippingPriceError`"
203 # - "`taxError`"
204 # - "`undeliverableShippingAddress`"
205 # - "`unsupportedPoBoxAddress`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 "reasonText": "A String", # The explanation of the reason.
207 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
208 }
209
210
211Returns:
212 An object of the form:
213
214 {
215 "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
216 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 #
218 # Acceptable values are:
219 # - "`duplicate`"
220 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 }</pre>
222</div>
223
224<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 <code class="details" id="cancellineitem">cancellineitem(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 <pre>Cancels a line item, making a full refund.
227
228Args:
229 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
230 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 The object takes the form of:
233
234{
235 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
236 "reason": "A String", # The reason for the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]237 #
238 # Acceptable values are:
239 # - "`customerInitiatedCancel`"
240 # - "`invalidCoupon`"
241 # - "`malformedShippingAddress`"
242 # - "`noInventory`"
243 # - "`other`"
244 # - "`priceError`"
245 # - "`shippingPriceError`"
246 # - "`taxError`"
247 # - "`undeliverableShippingAddress`"
248 # - "`unsupportedPoBoxAddress`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "reasonText": "A String", # The explanation of the reason.
250 "lineItemId": "A String", # The ID of the line item to cancel. Either lineItemId or productId is required.
251 "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.
252 "quantity": 42, # The quantity to cancel.
253 }
254
255
256Returns:
257 An object of the form:
258
259 {
260 "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
261 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 #
263 # Acceptable values are:
264 # - "`duplicate`"
265 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 }</pre>
267</div>
268
269<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 <code class="details" id="canceltestorderbycustomer">canceltestorderbycustomer(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 <pre>Sandbox only. Cancels a test order for customer-initiated cancellation.
272
273Args:
274 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
275 orderId: string, The ID of the test order to cancel. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 The object takes the form of:
278
279{
280 "reason": "A String", # The reason for the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 #
282 # Acceptable values are:
283 # - "`changedMind`"
284 # - "`orderedWrongItem`"
285 # - "`other`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]286 }
287
288
289Returns:
290 An object of the form:
291
292 {
293 "kind": "content#ordersCancelTestOrderByCustomerResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".
294 }</pre>
295</div>
296
297<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 <code class="details" id="createtestorder">createtestorder(merchantId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 <pre>Sandbox only. Creates a test order.
300
301Args:
302 merchantId: string, The ID of the account that should manage the order. This cannot be a multi-client account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]303 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 The object takes the form of:
305
306{
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]307 "country": "A String", # The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 #
309 # Acceptable values are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 # - "`US`"
311 # - "`FR`" Defaults to `US`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]312 "testOrder": { # The test order to create.
313 "promotions": [ # Promotions associated with the order.
314 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]315 "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
316 "title": "A String", # Required. The title of the promotion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
318 "currency": "A String", # The currency of the price.
319 "value": "A String", # The price represented as a number.
320 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 "currency": "A String", # The currency of the price.
323 "value": "A String", # The price represented as a number.
324 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325 "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
326 "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
327 #
328 # Acceptable values are:
329 # - "`buyMGetMoneyOff`"
330 # - "`buyMGetNMoneyOff`"
331 # - "`buyMGetNPercentOff`"
332 # - "`buyMGetPercentOff`"
333 # - "`freeGift`"
334 # - "`freeGiftWithItemId`"
335 # - "`freeGiftWithValue`"
336 # - "`freeShippingOvernight`"
337 # - "`freeShippingStandard`"
338 # - "`freeShippingTwoDay`"
339 # - "`moneyOff`"
340 # - "`percentOff`"
341 # - "`rewardPoints`"
342 # - "`salePrice`"
343 "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
344 "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
347 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
348 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
349 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 },
351 ],
352 "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
353 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
355 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
356 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
357 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 },
359 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]360 "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
361 "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
362 #
363 # Acceptable values are:
364 # - "`product`"
365 # - "`shipping`"
366 "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
367 #
368 # Acceptable values are:
369 # - "`google`"
370 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 },
372 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]373 "predefinedEmail": "A String", # Required. Email address of the customer.
374 #
375 # Acceptable values are:
376 # - "`pog.dwight.schrute@gmail.com`"
377 # - "`pog.jim.halpert@gmail.com`"
378 # - "`penpog.pam.beesly@gmail.comding`"
379 "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
380 "notificationMode": "A String", # Restricted. Do not use.
381 "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
382 #
383 # Acceptable values are:
384 # - "`dwight`"
385 # - "`jim`"
386 # - "`pam`"
387 "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 "currency": "A String", # The currency of the price.
389 "value": "A String", # The price represented as a number.
390 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]391 "shippingOption": "A String", # Required. The requested shipping option.
392 #
393 # Acceptable values are:
394 # - "`economy`"
395 # - "`expedited`"
396 # - "`oneDay`"
397 # - "`sameDay`"
398 # - "`standard`"
399 # - "`twoDay`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 "enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 "lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]403 "returnInfo": { # Required. Details of the return policy for the line item.
404 "policyUrl": "A String", # Required. URL of the item return policy.
405 "isReturnable": True or False, # Required. Whether the item is returnable.
406 "daysToReturn": 42, # Required. How many days later the item can be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]407 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 "product": { # Required. Product data from the time of the order placement.
409 "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
410 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
411 #
412 # Acceptable values are:
413 # - "`en`"
414 # - "`fr`"
415 "title": "A String", # Required. The title of the product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
417 "variantAttributes": [ # Variant attributes for the item. Optional.
418 {
419 "dimension": "A String", # The dimension of the variant.
420 "value": "A String", # The value for the dimension.
421 },
422 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]423 "brand": "A String", # Required. Brand of the item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "offerId": "A String", # Required. An identifier of the item.
426 "imageLink": "A String", # Required. URL of an image of the item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]427 "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
428 "fees": [ # Fees for the item. Optional.
429 {
430 "amount": { # Amount of the fee.
431 "currency": "A String", # The currency of the price.
432 "value": "A String", # The price represented as a number.
433 },
434 "name": "A String", # Name of the fee.
435 },
436 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]437 "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 "currency": "A String", # The currency of the price.
439 "value": "A String", # The price represented as a number.
440 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "condition": "A String", # Required. Condition or state of the item.
442 #
443 # Acceptable values are:
444 # - "`new`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "quantityOrdered": 42, # Required. Number of items ordered.
447 "shippingDetails": { # Required. Details of the requested shipping for the line item.
448 "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
449 "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
450 #
451 # Acceptable values are:
452 # - "`delivery`"
453 # - "`pickup`"
454 "method": { # Required. Details of the shipping method.
455 "minDaysInTransit": 42, # Required. Minimum transit time.
456 "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
457 "methodName": "A String", # Required. The name of the shipping method.
458 "maxDaysInTransit": 42, # Required. Maximum transit time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460 "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 },
462 },
463 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]464 "predefinedBillingAddress": "A String", # Required. The billing address.
465 #
466 # Acceptable values are:
467 # - "`dwight`"
468 # - "`jim`"
469 # - "`pam`"
470 "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
471 #
472 # Acceptable values are:
473 # - "`dwight`"
474 # - "`jim`"
475 # - "`pam`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 "templateName": "A String", # The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template.
478 #
479 # Acceptable values are:
480 # - "`template1`"
481 # - "`template1a`"
482 # - "`template1b`"
483 # - "`template2`"
484 # - "`template3`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 }
486
487
488Returns:
489 An object of the form:
490
491 {
492 "orderId": "A String", # The ID of the newly created test order.
493 "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
494 }</pre>
495</div>
496
497<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 <code class="details" id="createtestreturn">createtestreturn(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]499 <pre>Sandbox only. Creates a test return.
500
501Args:
502 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
503 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]504 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]505 The object takes the form of:
506
507{
508 "items": [ # Returned items.
509 {
510 "lineItemId": "A String", # The ID of the line item to return.
511 "quantity": 42, # Quantity that is returned.
512 },
513 ],
514 }
515
516
517Returns:
518 An object of the form:
519
520 {
521 "returnId": "A String", # The ID of the newly created test order return.
522 "kind": "content#ordersCreateTestReturnResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".
523 }</pre>
524</div>
525
526<div class="method">
527 <code class="details" id="get">get(merchantId, orderId)</code>
528 <pre>Retrieves an order from your Merchant Center account.
529
530Args:
531 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
532 orderId: string, The ID of the order. (required)
533
534Returns:
535 An object of the form:
536
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 { # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 "customer": { # The details of the customer who placed the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]539 "loyaltyInfo": { # Loyalty program information.
540 "loyaltyNumber": "A String", # The loyalty card/membership number.
541 "name": "A String", # Name of card/membership holder, this field will be populated when
542 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 "fullName": "A String", # Full name of the customer.
544 "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
546 #
547 # Acceptable values are:
548 # - "`denied`"
549 # - "`granted`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]550 "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]551 "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]553 "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 },
555 "promotions": [ # Promotions associated with the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]556 #
557 # To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
558 #
559 # Examples:
560 # - To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`.
561 # - To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item.
562 #
563 # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price.
564 #
565 # More details about the program are here.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]567 "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
568 "title": "A String", # Required. The title of the promotion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
570 "currency": "A String", # The currency of the price.
571 "value": "A String", # The price represented as a number.
572 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]573 "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]574 "currency": "A String", # The currency of the price.
575 "value": "A String", # The price represented as a number.
576 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]577 "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
578 "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
579 #
580 # Acceptable values are:
581 # - "`buyMGetMoneyOff`"
582 # - "`buyMGetNMoneyOff`"
583 # - "`buyMGetNPercentOff`"
584 # - "`buyMGetPercentOff`"
585 # - "`freeGift`"
586 # - "`freeGiftWithItemId`"
587 # - "`freeGiftWithValue`"
588 # - "`freeShippingOvernight`"
589 # - "`freeShippingStandard`"
590 # - "`freeShippingTwoDay`"
591 # - "`moneyOff`"
592 # - "`percentOff`"
593 # - "`rewardPoints`"
594 # - "`salePrice`"
595 "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
596 "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]598 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
599 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
600 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
601 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]602 },
603 ],
604 "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
605 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]606 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
607 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
608 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
609 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 },
611 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]612 "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
613 "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
614 #
615 # Acceptable values are:
616 # - "`product`"
617 # - "`shipping`"
618 "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
619 #
620 # Acceptable values are:
621 # - "`google`"
622 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 },
624 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]625 "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 "shippingCostTax": { # The tax for the total shipping cost.
627 "currency": "A String", # The currency of the price.
628 "value": "A String", # The price represented as a number.
629 },
630 "shipments": [ # Shipments of the order.
631 {
632 "status": "A String", # The status of the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]633 #
634 # Acceptable values are:
635 # - "`delivered`"
636 # - "`readyForPickup`"
637 # - "`shipped`"
638 # - "`undeliverable`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]639 "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]640 "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]641 "carrier": "A String", # The carrier handling the shipment.
642 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]643 # For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
644 # Supported carriers for US are:
645 # - "`ups`" (United Parcel Service) automatic status updates
646 # - "`usps`" (United States Postal Service) automatic status updates
647 # - "`fedex`" (FedEx) automatic status updates
648 # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
649 # - "`ontrac`" (OnTrac) automatic status updates
650 # - "`dhl express`" (DHL Express)
651 # - "`deliv`" (Deliv)
652 # - "`dynamex`" (TForce)
653 # - "`lasership`" (LaserShip)
654 # - "`mpx`" (Military Parcel Xpress)
655 # - "`uds`" (United Delivery Service)
656 # - "`efw`" (Estes Forwarding Worldwide)
657 # - "`jd logistics`" (JD Logistics)
658 # - "`yunexpress`" (YunExpress)
659 # - "`china post`" (China Post)
660 # - "`china ems`" (China Post Express Mail Service)
661 # - "`singapore post`" (Singapore Post)
662 # - "`pos malaysia`" (Pos Malaysia)
663 # - "`postnl`" (PostNL)
664 # - "`ptt`" (PTT Turkish Post)
665 # - "`eub`" (ePacket)
666 # - "`chukou1`" (Chukou1 Logistics)
667 # Supported carriers for FR are:
668 # - "`la poste`" (La Poste) automatic status updates
669 # - "`colissimo`" (Colissimo by La Poste) automatic status updates
670 # - "`ups`" (United Parcel Service) automatic status updates
671 # - "`chronopost`" (Chronopost by La Poste)
672 # - "`gls`" (General Logistics Systems France)
673 # - "`dpd`" (DPD Group by GeoPost)
674 # - "`bpost`" (Belgian Post Group)
675 # - "`colis prive`" (Colis Privé)
676 # - "`boxtal`" (Boxtal)
677 # - "`geodis`" (GEODIS)
678 # - "`tnt`" (TNT)
679 # - "`db schenker`" (DB Schenker)
680 # - "`aramex`" (Aramex)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]681 "trackingId": "A String", # The tracking ID for the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]682 "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]683 "lineItems": [ # The line items that are shipped.
684 {
685 "quantity": 42, # The quantity that is shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]686 "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]687 "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
688 },
689 ],
690 "id": "A String", # The ID of the shipment.
691 },
692 ],
693 "refunds": [ # Refunds for the order.
694 {
695 "amount": { # The amount that is refunded.
696 "currency": "A String", # The currency of the price.
697 "value": "A String", # The price represented as a number.
698 },
699 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
700 "reason": "A String", # The reason for the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]701 #
702 # Acceptable values are:
703 # - "`adjustment`"
704 # - "`autoPostInternal`"
705 # - "`autoPostInvalidBillingAddress`"
706 # - "`autoPostNoInventory`"
707 # - "`autoPostPriceError`"
708 # - "`autoPostUndeliverableShippingAddress`"
709 # - "`couponAbuse`"
710 # - "`courtesyAdjustment`"
711 # - "`customerCanceled`"
712 # - "`customerDiscretionaryReturn`"
713 # - "`customerInitiatedMerchantCancel`"
714 # - "`customerSupportRequested`"
715 # - "`deliveredLateByCarrier`"
716 # - "`deliveredTooLate`"
717 # - "`expiredItem`"
718 # - "`failToPushOrderGoogleError`"
719 # - "`failToPushOrderMerchantError`"
720 # - "`failToPushOrderMerchantFulfillmentError`"
721 # - "`failToPushOrderToMerchant`"
722 # - "`failToPushOrderToMerchantOutOfStock`"
723 # - "`feeAdjustment`"
724 # - "`invalidCoupon`"
725 # - "`lateShipmentCredit`"
726 # - "`malformedShippingAddress`"
727 # - "`merchantDidNotShipOnTime`"
728 # - "`noInventory`"
729 # - "`orderTimeout`"
730 # - "`other`"
731 # - "`paymentAbuse`"
732 # - "`paymentDeclined`"
733 # - "`priceAdjustment`"
734 # - "`priceError`"
735 # - "`productArrivedDamaged`"
736 # - "`productNotAsDescribed`"
737 # - "`promoReallocation`"
738 # - "`qualityNotAsExpected`"
739 # - "`returnRefundAbuse`"
740 # - "`shippingCostAdjustment`"
741 # - "`shippingPriceError`"
742 # - "`taxAdjustment`"
743 # - "`taxError`"
744 # - "`undeliverableShippingAddress`"
745 # - "`unsupportedPoBoxAddress`"
746 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]748 #
749 # Acceptable values are:
750 # - "`customer`"
751 # - "`googleBot`"
752 # - "`googleCustomerService`"
753 # - "`googlePayments`"
754 # - "`googleSabre`"
755 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]756 "reasonText": "A String", # The explanation of the reason.
757 },
758 ],
759 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 #
761 # Acceptable values are:
762 # - "`marketplaceFacilitator`"
763 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]764 "acknowledged": True or False, # Whether the order was acknowledged.
765 "paymentStatus": "A String", # The status of the payment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]766 #
767 # Acceptable values are:
768 # - "`paymentCaptured`"
769 # - "`paymentRejected`"
770 # - "`paymentSecured`"
771 # - "`pendingAuthorization`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]772 "merchantId": "A String",
773 "merchantOrderId": "A String", # Merchant-provided ID of the order.
774 "status": "A String", # The status of the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]775 #
776 # Acceptable values are:
777 # - "`canceled`"
778 # - "`delivered`"
779 # - "`inProgress`"
780 # - "`partiallyDelivered`"
781 # - "`partiallyReturned`"
782 # - "`partiallyShipped`"
783 # - "`pendingShipment`"
784 # - "`returned`"
785 # - "`shipped`"
786 "pickupDetails": { # Pickup details for shipments of type `pickup`.
787 "locationId": "A String", # ID of the pickup location.
788 "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
789 {
790 "phoneNumber": "A String", # Phone number of the person picking up the shipment.
791 "name": "A String", # Name of the person picking up the shipment.
792 },
793 ],
794 "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
795 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
796 "country": "A String", # CLDR country code (e.g. "US").
797 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
798 # John Smith
799 # 1600 Amphitheatre Parkway
800 # Mountain View, CA, 94043
801 # United States
802 "A String",
803 ],
804 "streetAddress": [ # Street-level part of the address.
805 "A String",
806 ],
807 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
808 "recipientName": "A String", # Name of the recipient.
809 "isPostOfficeBox": True or False, # Whether the address is a post office box.
810 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
811 },
812 },
813 "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]814 "currency": "A String", # The currency of the price.
815 "value": "A String", # The price represented as a number.
816 },
817 "billingAddress": { # The billing address.
818 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
819 "country": "A String", # CLDR country code (e.g. "US").
820 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
821 # John Smith
822 # 1600 Amphitheatre Parkway
823 # Mountain View, CA, 94043
824 # United States
825 "A String",
826 ],
827 "streetAddress": [ # Street-level part of the address.
828 "A String",
829 ],
830 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
831 "recipientName": "A String", # Name of the recipient.
832 "isPostOfficeBox": True or False, # Whether the address is a post office box.
833 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
834 },
835 "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
836 "currency": "A String", # The currency of the price.
837 "value": "A String", # The price represented as a number.
838 },
839 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
840 "lineItems": [ # Line items that are ordered.
841 {
842 "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
843 "targetCountry": "A String", # The CLDR territory code of the target country of the product.
844 "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
845 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
846 "title": "A String", # The title of the product.
847 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
848 "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.
849 {
850 "dimension": "A String", # The dimension of the variant.
851 "value": "A String", # The value for the dimension.
852 },
853 ],
854 "brand": "A String", # Brand of the item.
855 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
856 "offerId": "A String", # An identifier of the item.
857 "price": { # Price of the item.
858 "currency": "A String", # The currency of the price.
859 "value": "A String", # The price represented as a number.
860 },
861 "imageLink": "A String", # URL of an image of the item.
862 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
863 "fees": [ # Associated fees at order creation time.
864 {
865 "amount": { # Amount of the fee.
866 "currency": "A String", # The currency of the price.
867 "value": "A String", # The price represented as a number.
868 },
869 "name": "A String", # Name of the fee.
870 },
871 ],
872 "id": "A String", # The REST ID of the product.
873 "condition": "A String", # Condition or state of the item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]874 #
875 # Acceptable values are:
876 # - "`new`"
877 # - "`refurbished`"
878 # - "`used`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]879 },
880 "quantityPending": 42, # Number of items pending.
881 "quantityDelivered": 42, # Number of items delivered.
882 "returnInfo": { # Details of the return policy for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]883 "policyUrl": "A String", # Required. URL of the item return policy.
884 "isReturnable": True or False, # Required. Whether the item is returnable.
885 "daysToReturn": 42, # Required. How many days later the item can be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]886 },
887 "quantityOrdered": 42, # Number of items ordered.
888 "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
889 "currency": "A String", # The currency of the price.
890 "value": "A String", # The price represented as a number.
891 },
892 "adjustments": [ # Price and tax adjustments applied on the line item.
893 {
894 "type": "A String", # Type of this adjustment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]895 #
896 # Acceptable values are:
897 # - "`promotion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]898 "priceAdjustment": { # Adjustment for total price of the line item.
899 "currency": "A String", # The currency of the price.
900 "value": "A String", # The price represented as a number.
901 },
902 "taxAdjustment": { # Adjustment for total tax of the line item.
903 "currency": "A String", # The currency of the price.
904 "value": "A String", # The price represented as a number.
905 },
906 },
907 ],
908 "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
909 "currency": "A String", # The currency of the price.
910 "value": "A String", # The price represented as a number.
911 },
912 "cancellations": [ # Cancellations of the line item.
913 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]914 "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
915 #
916 # Acceptable values are:
917 # - "`autoPostInternal`"
918 # - "`autoPostInvalidBillingAddress`"
919 # - "`autoPostNoInventory`"
920 # - "`autoPostPriceError`"
921 # - "`autoPostUndeliverableShippingAddress`"
922 # - "`couponAbuse`"
923 # - "`customerCanceled`"
924 # - "`customerInitiatedCancel`"
925 # - "`customerSupportRequested`"
926 # - "`failToPushOrderGoogleError`"
927 # - "`failToPushOrderMerchantError`"
928 # - "`failToPushOrderMerchantFulfillmentError`"
929 # - "`failToPushOrderToMerchant`"
930 # - "`failToPushOrderToMerchantOutOfStock`"
931 # - "`invalidCoupon`"
932 # - "`malformedShippingAddress`"
933 # - "`merchantDidNotShipOnTime`"
934 # - "`noInventory`"
935 # - "`orderTimeout`"
936 # - "`other`"
937 # - "`paymentAbuse`"
938 # - "`paymentDeclined`"
939 # - "`priceError`"
940 # - "`returnRefundAbuse`"
941 # - "`shippingPriceError`"
942 # - "`taxError`"
943 # - "`undeliverableShippingAddress`"
944 # - "`unsupportedPoBoxAddress`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]945 "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
946 "reasonText": "A String", # The explanation of the reason.
947 "actor": "A String", # The actor that created the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]948 #
949 # Acceptable values are:
950 # - "`customer`"
951 # - "`googleBot`"
952 # - "`googleCustomerService`"
953 # - "`googlePayments`"
954 # - "`googleSabre`"
955 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]956 "quantity": 42, # The quantity that was canceled.
957 },
958 ],
959 "quantityCanceled": 42, # Number of items canceled.
960 "annotations": [ # Annotations that are attached to the line item.
961 {
962 "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
963 "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
964 },
965 ],
966 "returns": [ # Returns of the line item.
967 {
968 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]969 #
970 # Acceptable values are:
971 # - "`customerDiscretionaryReturn`"
972 # - "`customerInitiatedMerchantCancel`"
973 # - "`deliveredTooLate`"
974 # - "`expiredItem`"
975 # - "`invalidCoupon`"
976 # - "`malformedShippingAddress`"
977 # - "`other`"
978 # - "`productArrivedDamaged`"
979 # - "`productNotAsDescribed`"
980 # - "`qualityNotAsExpected`"
981 # - "`undeliverableShippingAddress`"
982 # - "`unsupportedPoBoxAddress`"
983 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]984 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
985 "reasonText": "A String", # The explanation of the reason.
986 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]987 #
988 # Acceptable values are:
989 # - "`customer`"
990 # - "`googleBot`"
991 # - "`googleCustomerService`"
992 # - "`googlePayments`"
993 # - "`googleSabre`"
994 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]995 "quantity": 42, # Quantity that is returned.
996 },
997 ],
998 "quantityShipped": 42, # Number of items shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]999 "quantityReadyForPickup": 42, # Number of items ready for pickup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1000 "quantityReturned": 42, # Number of items returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1001 "quantityUndeliverable": 42, # Number of items undeliverable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1002 "id": "A String", # The ID of the line item.
1003 "shippingDetails": { # Details of the requested shipping for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1004 "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
1005 "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
1006 #
1007 # Acceptable values are:
1008 # - "`delivery`"
1009 # - "`pickup`"
1010 "method": { # Required. Details of the shipping method.
1011 "minDaysInTransit": 42, # Required. Minimum transit time.
1012 "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
1013 "methodName": "A String", # Required. The name of the shipping method.
1014 "maxDaysInTransit": 42, # Required. Maximum transit time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1015 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1016 "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1017 },
1018 },
1019 ],
1020 "shippingCost": { # The total cost of shipping for all items.
1021 "currency": "A String", # The currency of the price.
1022 "value": "A String", # The price represented as a number.
1023 },
1024 "id": "A String", # The REST ID of the order. Globally unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1025 "deliveryDetails": { # Delivery details for shipments of type `delivery`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1026 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
1027 "address": { # The delivery address
1028 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
1029 "country": "A String", # CLDR country code (e.g. "US").
1030 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
1031 # John Smith
1032 # 1600 Amphitheatre Parkway
1033 # Mountain View, CA, 94043
1034 # United States
1035 "A String",
1036 ],
1037 "streetAddress": [ # Street-level part of the address.
1038 "A String",
1039 ],
1040 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
1041 "recipientName": "A String", # Name of the recipient.
1042 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1043 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
1044 },
1045 },
1046 }</pre>
1047</div>
1048
1049<div class="method">
1050 <code class="details" id="getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</code>
1051 <pre>Retrieves an order using merchant order ID.
1052
1053Args:
1054 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
1055 merchantOrderId: string, The merchant order ID to be looked for. (required)
1056
1057Returns:
1058 An object of the form:
1059
1060 {
1061 "kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1062 "order": { # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==) # The requested order.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1063 "customer": { # The details of the customer who placed the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1064 "loyaltyInfo": { # Loyalty program information.
1065 "loyaltyNumber": "A String", # The loyalty card/membership number.
1066 "name": "A String", # Name of card/membership holder, this field will be populated when
1067 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1068 "fullName": "A String", # Full name of the customer.
1069 "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1070 "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
1071 #
1072 # Acceptable values are:
1073 # - "`denied`"
1074 # - "`granted`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1075 "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1076 "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1077 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1078 "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1079 },
1080 "promotions": [ # Promotions associated with the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1081 #
1082 # To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
1083 #
1084 # Examples:
1085 # - To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`.
1086 # - To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item.
1087 #
1088 # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price.
1089 #
1090 # More details about the program are here.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1091 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1092 "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
1093 "title": "A String", # Required. The title of the promotion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1094 "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
1095 "currency": "A String", # The currency of the price.
1096 "value": "A String", # The price represented as a number.
1097 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1098 "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1099 "currency": "A String", # The currency of the price.
1100 "value": "A String", # The price represented as a number.
1101 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1102 "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
1103 "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
1104 #
1105 # Acceptable values are:
1106 # - "`buyMGetMoneyOff`"
1107 # - "`buyMGetNMoneyOff`"
1108 # - "`buyMGetNPercentOff`"
1109 # - "`buyMGetPercentOff`"
1110 # - "`freeGift`"
1111 # - "`freeGiftWithItemId`"
1112 # - "`freeGiftWithValue`"
1113 # - "`freeShippingOvernight`"
1114 # - "`freeShippingStandard`"
1115 # - "`freeShippingTwoDay`"
1116 # - "`moneyOff`"
1117 # - "`percentOff`"
1118 # - "`rewardPoints`"
1119 # - "`salePrice`"
1120 "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1121 "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1122 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1123 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1124 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1125 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1126 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1127 },
1128 ],
1129 "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
1130 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1131 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1132 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1133 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1134 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1135 },
1136 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1137 "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1138 "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
1139 #
1140 # Acceptable values are:
1141 # - "`product`"
1142 # - "`shipping`"
1143 "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
1144 #
1145 # Acceptable values are:
1146 # - "`google`"
1147 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1148 },
1149 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1150 "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1151 "shippingCostTax": { # The tax for the total shipping cost.
1152 "currency": "A String", # The currency of the price.
1153 "value": "A String", # The price represented as a number.
1154 },
1155 "shipments": [ # Shipments of the order.
1156 {
1157 "status": "A String", # The status of the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1158 #
1159 # Acceptable values are:
1160 # - "`delivered`"
1161 # - "`readyForPickup`"
1162 # - "`shipped`"
1163 # - "`undeliverable`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1164 "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1165 "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1166 "carrier": "A String", # The carrier handling the shipment.
1167 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1168 # For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
1169 # Supported carriers for US are:
1170 # - "`ups`" (United Parcel Service) automatic status updates
1171 # - "`usps`" (United States Postal Service) automatic status updates
1172 # - "`fedex`" (FedEx) automatic status updates
1173 # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
1174 # - "`ontrac`" (OnTrac) automatic status updates
1175 # - "`dhl express`" (DHL Express)
1176 # - "`deliv`" (Deliv)
1177 # - "`dynamex`" (TForce)
1178 # - "`lasership`" (LaserShip)
1179 # - "`mpx`" (Military Parcel Xpress)
1180 # - "`uds`" (United Delivery Service)
1181 # - "`efw`" (Estes Forwarding Worldwide)
1182 # - "`jd logistics`" (JD Logistics)
1183 # - "`yunexpress`" (YunExpress)
1184 # - "`china post`" (China Post)
1185 # - "`china ems`" (China Post Express Mail Service)
1186 # - "`singapore post`" (Singapore Post)
1187 # - "`pos malaysia`" (Pos Malaysia)
1188 # - "`postnl`" (PostNL)
1189 # - "`ptt`" (PTT Turkish Post)
1190 # - "`eub`" (ePacket)
1191 # - "`chukou1`" (Chukou1 Logistics)
1192 # Supported carriers for FR are:
1193 # - "`la poste`" (La Poste) automatic status updates
1194 # - "`colissimo`" (Colissimo by La Poste) automatic status updates
1195 # - "`ups`" (United Parcel Service) automatic status updates
1196 # - "`chronopost`" (Chronopost by La Poste)
1197 # - "`gls`" (General Logistics Systems France)
1198 # - "`dpd`" (DPD Group by GeoPost)
1199 # - "`bpost`" (Belgian Post Group)
1200 # - "`colis prive`" (Colis Privé)
1201 # - "`boxtal`" (Boxtal)
1202 # - "`geodis`" (GEODIS)
1203 # - "`tnt`" (TNT)
1204 # - "`db schenker`" (DB Schenker)
1205 # - "`aramex`" (Aramex)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1206 "trackingId": "A String", # The tracking ID for the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1207 "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1208 "lineItems": [ # The line items that are shipped.
1209 {
1210 "quantity": 42, # The quantity that is shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1211 "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1212 "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
1213 },
1214 ],
1215 "id": "A String", # The ID of the shipment.
1216 },
1217 ],
1218 "refunds": [ # Refunds for the order.
1219 {
1220 "amount": { # The amount that is refunded.
1221 "currency": "A String", # The currency of the price.
1222 "value": "A String", # The price represented as a number.
1223 },
1224 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1225 "reason": "A String", # The reason for the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1226 #
1227 # Acceptable values are:
1228 # - "`adjustment`"
1229 # - "`autoPostInternal`"
1230 # - "`autoPostInvalidBillingAddress`"
1231 # - "`autoPostNoInventory`"
1232 # - "`autoPostPriceError`"
1233 # - "`autoPostUndeliverableShippingAddress`"
1234 # - "`couponAbuse`"
1235 # - "`courtesyAdjustment`"
1236 # - "`customerCanceled`"
1237 # - "`customerDiscretionaryReturn`"
1238 # - "`customerInitiatedMerchantCancel`"
1239 # - "`customerSupportRequested`"
1240 # - "`deliveredLateByCarrier`"
1241 # - "`deliveredTooLate`"
1242 # - "`expiredItem`"
1243 # - "`failToPushOrderGoogleError`"
1244 # - "`failToPushOrderMerchantError`"
1245 # - "`failToPushOrderMerchantFulfillmentError`"
1246 # - "`failToPushOrderToMerchant`"
1247 # - "`failToPushOrderToMerchantOutOfStock`"
1248 # - "`feeAdjustment`"
1249 # - "`invalidCoupon`"
1250 # - "`lateShipmentCredit`"
1251 # - "`malformedShippingAddress`"
1252 # - "`merchantDidNotShipOnTime`"
1253 # - "`noInventory`"
1254 # - "`orderTimeout`"
1255 # - "`other`"
1256 # - "`paymentAbuse`"
1257 # - "`paymentDeclined`"
1258 # - "`priceAdjustment`"
1259 # - "`priceError`"
1260 # - "`productArrivedDamaged`"
1261 # - "`productNotAsDescribed`"
1262 # - "`promoReallocation`"
1263 # - "`qualityNotAsExpected`"
1264 # - "`returnRefundAbuse`"
1265 # - "`shippingCostAdjustment`"
1266 # - "`shippingPriceError`"
1267 # - "`taxAdjustment`"
1268 # - "`taxError`"
1269 # - "`undeliverableShippingAddress`"
1270 # - "`unsupportedPoBoxAddress`"
1271 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1272 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1273 #
1274 # Acceptable values are:
1275 # - "`customer`"
1276 # - "`googleBot`"
1277 # - "`googleCustomerService`"
1278 # - "`googlePayments`"
1279 # - "`googleSabre`"
1280 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1281 "reasonText": "A String", # The explanation of the reason.
1282 },
1283 ],
1284 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1285 #
1286 # Acceptable values are:
1287 # - "`marketplaceFacilitator`"
1288 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1289 "acknowledged": True or False, # Whether the order was acknowledged.
1290 "paymentStatus": "A String", # The status of the payment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1291 #
1292 # Acceptable values are:
1293 # - "`paymentCaptured`"
1294 # - "`paymentRejected`"
1295 # - "`paymentSecured`"
1296 # - "`pendingAuthorization`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1297 "merchantId": "A String",
1298 "merchantOrderId": "A String", # Merchant-provided ID of the order.
1299 "status": "A String", # The status of the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1300 #
1301 # Acceptable values are:
1302 # - "`canceled`"
1303 # - "`delivered`"
1304 # - "`inProgress`"
1305 # - "`partiallyDelivered`"
1306 # - "`partiallyReturned`"
1307 # - "`partiallyShipped`"
1308 # - "`pendingShipment`"
1309 # - "`returned`"
1310 # - "`shipped`"
1311 "pickupDetails": { # Pickup details for shipments of type `pickup`.
1312 "locationId": "A String", # ID of the pickup location.
1313 "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
1314 {
1315 "phoneNumber": "A String", # Phone number of the person picking up the shipment.
1316 "name": "A String", # Name of the person picking up the shipment.
1317 },
1318 ],
1319 "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
1320 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
1321 "country": "A String", # CLDR country code (e.g. "US").
1322 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
1323 # John Smith
1324 # 1600 Amphitheatre Parkway
1325 # Mountain View, CA, 94043
1326 # United States
1327 "A String",
1328 ],
1329 "streetAddress": [ # Street-level part of the address.
1330 "A String",
1331 ],
1332 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
1333 "recipientName": "A String", # Name of the recipient.
1334 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1335 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
1336 },
1337 },
1338 "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1339 "currency": "A String", # The currency of the price.
1340 "value": "A String", # The price represented as a number.
1341 },
1342 "billingAddress": { # The billing address.
1343 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
1344 "country": "A String", # CLDR country code (e.g. "US").
1345 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
1346 # John Smith
1347 # 1600 Amphitheatre Parkway
1348 # Mountain View, CA, 94043
1349 # United States
1350 "A String",
1351 ],
1352 "streetAddress": [ # Street-level part of the address.
1353 "A String",
1354 ],
1355 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
1356 "recipientName": "A String", # Name of the recipient.
1357 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1358 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
1359 },
1360 "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
1361 "currency": "A String", # The currency of the price.
1362 "value": "A String", # The price represented as a number.
1363 },
1364 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
1365 "lineItems": [ # Line items that are ordered.
1366 {
1367 "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
1368 "targetCountry": "A String", # The CLDR territory code of the target country of the product.
1369 "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
1370 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
1371 "title": "A String", # The title of the product.
1372 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
1373 "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.
1374 {
1375 "dimension": "A String", # The dimension of the variant.
1376 "value": "A String", # The value for the dimension.
1377 },
1378 ],
1379 "brand": "A String", # Brand of the item.
1380 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
1381 "offerId": "A String", # An identifier of the item.
1382 "price": { # Price of the item.
1383 "currency": "A String", # The currency of the price.
1384 "value": "A String", # The price represented as a number.
1385 },
1386 "imageLink": "A String", # URL of an image of the item.
1387 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
1388 "fees": [ # Associated fees at order creation time.
1389 {
1390 "amount": { # Amount of the fee.
1391 "currency": "A String", # The currency of the price.
1392 "value": "A String", # The price represented as a number.
1393 },
1394 "name": "A String", # Name of the fee.
1395 },
1396 ],
1397 "id": "A String", # The REST ID of the product.
1398 "condition": "A String", # Condition or state of the item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1399 #
1400 # Acceptable values are:
1401 # - "`new`"
1402 # - "`refurbished`"
1403 # - "`used`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1404 },
1405 "quantityPending": 42, # Number of items pending.
1406 "quantityDelivered": 42, # Number of items delivered.
1407 "returnInfo": { # Details of the return policy for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1408 "policyUrl": "A String", # Required. URL of the item return policy.
1409 "isReturnable": True or False, # Required. Whether the item is returnable.
1410 "daysToReturn": 42, # Required. How many days later the item can be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1411 },
1412 "quantityOrdered": 42, # Number of items ordered.
1413 "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
1414 "currency": "A String", # The currency of the price.
1415 "value": "A String", # The price represented as a number.
1416 },
1417 "adjustments": [ # Price and tax adjustments applied on the line item.
1418 {
1419 "type": "A String", # Type of this adjustment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1420 #
1421 # Acceptable values are:
1422 # - "`promotion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1423 "priceAdjustment": { # Adjustment for total price of the line item.
1424 "currency": "A String", # The currency of the price.
1425 "value": "A String", # The price represented as a number.
1426 },
1427 "taxAdjustment": { # Adjustment for total tax of the line item.
1428 "currency": "A String", # The currency of the price.
1429 "value": "A String", # The price represented as a number.
1430 },
1431 },
1432 ],
1433 "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
1434 "currency": "A String", # The currency of the price.
1435 "value": "A String", # The price represented as a number.
1436 },
1437 "cancellations": [ # Cancellations of the line item.
1438 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1439 "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
1440 #
1441 # Acceptable values are:
1442 # - "`autoPostInternal`"
1443 # - "`autoPostInvalidBillingAddress`"
1444 # - "`autoPostNoInventory`"
1445 # - "`autoPostPriceError`"
1446 # - "`autoPostUndeliverableShippingAddress`"
1447 # - "`couponAbuse`"
1448 # - "`customerCanceled`"
1449 # - "`customerInitiatedCancel`"
1450 # - "`customerSupportRequested`"
1451 # - "`failToPushOrderGoogleError`"
1452 # - "`failToPushOrderMerchantError`"
1453 # - "`failToPushOrderMerchantFulfillmentError`"
1454 # - "`failToPushOrderToMerchant`"
1455 # - "`failToPushOrderToMerchantOutOfStock`"
1456 # - "`invalidCoupon`"
1457 # - "`malformedShippingAddress`"
1458 # - "`merchantDidNotShipOnTime`"
1459 # - "`noInventory`"
1460 # - "`orderTimeout`"
1461 # - "`other`"
1462 # - "`paymentAbuse`"
1463 # - "`paymentDeclined`"
1464 # - "`priceError`"
1465 # - "`returnRefundAbuse`"
1466 # - "`shippingPriceError`"
1467 # - "`taxError`"
1468 # - "`undeliverableShippingAddress`"
1469 # - "`unsupportedPoBoxAddress`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1470 "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
1471 "reasonText": "A String", # The explanation of the reason.
1472 "actor": "A String", # The actor that created the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1473 #
1474 # Acceptable values are:
1475 # - "`customer`"
1476 # - "`googleBot`"
1477 # - "`googleCustomerService`"
1478 # - "`googlePayments`"
1479 # - "`googleSabre`"
1480 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1481 "quantity": 42, # The quantity that was canceled.
1482 },
1483 ],
1484 "quantityCanceled": 42, # Number of items canceled.
1485 "annotations": [ # Annotations that are attached to the line item.
1486 {
1487 "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
1488 "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
1489 },
1490 ],
1491 "returns": [ # Returns of the line item.
1492 {
1493 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1494 #
1495 # Acceptable values are:
1496 # - "`customerDiscretionaryReturn`"
1497 # - "`customerInitiatedMerchantCancel`"
1498 # - "`deliveredTooLate`"
1499 # - "`expiredItem`"
1500 # - "`invalidCoupon`"
1501 # - "`malformedShippingAddress`"
1502 # - "`other`"
1503 # - "`productArrivedDamaged`"
1504 # - "`productNotAsDescribed`"
1505 # - "`qualityNotAsExpected`"
1506 # - "`undeliverableShippingAddress`"
1507 # - "`unsupportedPoBoxAddress`"
1508 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1509 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
1510 "reasonText": "A String", # The explanation of the reason.
1511 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1512 #
1513 # Acceptable values are:
1514 # - "`customer`"
1515 # - "`googleBot`"
1516 # - "`googleCustomerService`"
1517 # - "`googlePayments`"
1518 # - "`googleSabre`"
1519 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1520 "quantity": 42, # Quantity that is returned.
1521 },
1522 ],
1523 "quantityShipped": 42, # Number of items shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1524 "quantityReadyForPickup": 42, # Number of items ready for pickup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1525 "quantityReturned": 42, # Number of items returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1526 "quantityUndeliverable": 42, # Number of items undeliverable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1527 "id": "A String", # The ID of the line item.
1528 "shippingDetails": { # Details of the requested shipping for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1529 "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
1530 "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
1531 #
1532 # Acceptable values are:
1533 # - "`delivery`"
1534 # - "`pickup`"
1535 "method": { # Required. Details of the shipping method.
1536 "minDaysInTransit": 42, # Required. Minimum transit time.
1537 "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
1538 "methodName": "A String", # Required. The name of the shipping method.
1539 "maxDaysInTransit": 42, # Required. Maximum transit time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1540 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1541 "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1542 },
1543 },
1544 ],
1545 "shippingCost": { # The total cost of shipping for all items.
1546 "currency": "A String", # The currency of the price.
1547 "value": "A String", # The price represented as a number.
1548 },
1549 "id": "A String", # The REST ID of the order. Globally unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1550 "deliveryDetails": { # Delivery details for shipments of type `delivery`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1551 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
1552 "address": { # The delivery address
1553 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
1554 "country": "A String", # CLDR country code (e.g. "US").
1555 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
1556 # John Smith
1557 # 1600 Amphitheatre Parkway
1558 # Mountain View, CA, 94043
1559 # United States
1560 "A String",
1561 ],
1562 "streetAddress": [ # Street-level part of the address.
1563 "A String",
1564 ],
1565 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
1566 "recipientName": "A String", # Name of the recipient.
1567 "isPostOfficeBox": True or False, # Whether the address is a post office box.
1568 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
1569 },
1570 },
1571 },
1572 }</pre>
1573</div>
1574
1575<div class="method">
1576 <code class="details" id="gettestordertemplate">gettestordertemplate(merchantId, templateName, country=None)</code>
1577 <pre>Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
1578
1579Args:
1580 merchantId: string, The ID of the account that should manage the order. This cannot be a multi-client account. (required)
1581 templateName: string, The name of the template to retrieve. (required)
1582 Allowed values
1583 template1 -
1584 template1a -
1585 template1b -
1586 template2 -
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1587 template3 -
1588 country: string, The country of the template to retrieve. Defaults to `US`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1589
1590Returns:
1591 An object of the form:
1592
1593 {
1594 "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
1595 "template": { # The requested test order template.
1596 "promotions": [ # Promotions associated with the order.
1597 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1598 "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
1599 "title": "A String", # Required. The title of the promotion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1600 "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
1601 "currency": "A String", # The currency of the price.
1602 "value": "A String", # The price represented as a number.
1603 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1604 "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1605 "currency": "A String", # The currency of the price.
1606 "value": "A String", # The price represented as a number.
1607 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1608 "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
1609 "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
1610 #
1611 # Acceptable values are:
1612 # - "`buyMGetMoneyOff`"
1613 # - "`buyMGetNMoneyOff`"
1614 # - "`buyMGetNPercentOff`"
1615 # - "`buyMGetPercentOff`"
1616 # - "`freeGift`"
1617 # - "`freeGiftWithItemId`"
1618 # - "`freeGiftWithValue`"
1619 # - "`freeShippingOvernight`"
1620 # - "`freeShippingStandard`"
1621 # - "`freeShippingTwoDay`"
1622 # - "`moneyOff`"
1623 # - "`percentOff`"
1624 # - "`rewardPoints`"
1625 # - "`salePrice`"
1626 "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1627 "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1628 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1629 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1630 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1631 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1632 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1633 },
1634 ],
1635 "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
1636 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1637 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1638 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1639 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1640 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1641 },
1642 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1643 "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1644 "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
1645 #
1646 # Acceptable values are:
1647 # - "`product`"
1648 # - "`shipping`"
1649 "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
1650 #
1651 # Acceptable values are:
1652 # - "`google`"
1653 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1654 },
1655 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1656 "predefinedEmail": "A String", # Required. Email address of the customer.
1657 #
1658 # Acceptable values are:
1659 # - "`pog.dwight.schrute@gmail.com`"
1660 # - "`pog.jim.halpert@gmail.com`"
1661 # - "`penpog.pam.beesly@gmail.comding`"
1662 "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`"
1663 "notificationMode": "A String", # Restricted. Do not use.
1664 "predefinedDeliveryAddress": "A String", # Required. Identifier of one of the predefined delivery addresses for the delivery.
1665 #
1666 # Acceptable values are:
1667 # - "`dwight`"
1668 # - "`jim`"
1669 # - "`pam`"
1670 "shippingCost": { # Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1671 "currency": "A String", # The currency of the price.
1672 "value": "A String", # The price represented as a number.
1673 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1674 "shippingOption": "A String", # Required. The requested shipping option.
1675 #
1676 # Acceptable values are:
1677 # - "`economy`"
1678 # - "`expedited`"
1679 # - "`oneDay`"
1680 # - "`sameDay`"
1681 # - "`standard`"
1682 # - "`twoDay`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1683 "enableOrderinvoices": True or False, # Whether the orderinvoices service should support this order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1684 "lineItems": [ # Required. Line items that are ordered. At least one line item must be provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1685 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1686 "returnInfo": { # Required. Details of the return policy for the line item.
1687 "policyUrl": "A String", # Required. URL of the item return policy.
1688 "isReturnable": True or False, # Required. Whether the item is returnable.
1689 "daysToReturn": 42, # Required. How many days later the item can be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1690 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1691 "product": { # Required. Product data from the time of the order placement.
1692 "targetCountry": "A String", # Required. The CLDR territory code of the target country of the product.
1693 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
1694 #
1695 # Acceptable values are:
1696 # - "`en`"
1697 # - "`fr`"
1698 "title": "A String", # Required. The title of the product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1699 "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
1700 "variantAttributes": [ # Variant attributes for the item. Optional.
1701 {
1702 "dimension": "A String", # The dimension of the variant.
1703 "value": "A String", # The value for the dimension.
1704 },
1705 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1706 "brand": "A String", # Required. Brand of the item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1707 "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1708 "offerId": "A String", # Required. An identifier of the item.
1709 "imageLink": "A String", # Required. URL of an image of the item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1710 "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
1711 "fees": [ # Fees for the item. Optional.
1712 {
1713 "amount": { # Amount of the fee.
1714 "currency": "A String", # The currency of the price.
1715 "value": "A String", # The price represented as a number.
1716 },
1717 "name": "A String", # Name of the fee.
1718 },
1719 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1720 "price": { # Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1721 "currency": "A String", # The currency of the price.
1722 "value": "A String", # The price represented as a number.
1723 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1724 "condition": "A String", # Required. Condition or state of the item.
1725 #
1726 # Acceptable values are:
1727 # - "`new`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1728 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1729 "quantityOrdered": 42, # Required. Number of items ordered.
1730 "shippingDetails": { # Required. Details of the requested shipping for the line item.
1731 "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
1732 "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
1733 #
1734 # Acceptable values are:
1735 # - "`delivery`"
1736 # - "`pickup`"
1737 "method": { # Required. Details of the shipping method.
1738 "minDaysInTransit": 42, # Required. Minimum transit time.
1739 "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
1740 "methodName": "A String", # Required. The name of the shipping method.
1741 "maxDaysInTransit": 42, # Required. Maximum transit time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1742 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1743 "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1744 },
1745 },
1746 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1747 "predefinedBillingAddress": "A String", # Required. The billing address.
1748 #
1749 # Acceptable values are:
1750 # - "`dwight`"
1751 # - "`jim`"
1752 # - "`pam`"
1753 "predefinedPickupDetails": "A String", # Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.
1754 #
1755 # Acceptable values are:
1756 # - "`dwight`"
1757 # - "`jim`"
1758 # - "`pam`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1759 },
1760 }</pre>
1761</div>
1762
1763<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1764 <code class="details" id="instorerefundlineitem">instorerefundlineitem(merchantId, orderId, body=None)</code>
1765 <pre>Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1766Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.
1767
1768Args:
1769 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
1770 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1771 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1772 The object takes the form of:
1773
1774{
1775 "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.
1776 "currency": "A String", # The currency of the price.
1777 "value": "A String", # The price represented as a number.
1778 },
1779 "taxAmount": { # The amount of tax to be refunded. Required.
1780 "currency": "A String", # The currency of the price.
1781 "value": "A String", # The price represented as a number.
1782 },
1783 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
1784 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1785 #
1786 # Acceptable values are:
1787 # - "`customerDiscretionaryReturn`"
1788 # - "`customerInitiatedMerchantCancel`"
1789 # - "`deliveredTooLate`"
1790 # - "`expiredItem`"
1791 # - "`invalidCoupon`"
1792 # - "`malformedShippingAddress`"
1793 # - "`other`"
1794 # - "`productArrivedDamaged`"
1795 # - "`productNotAsDescribed`"
1796 # - "`qualityNotAsExpected`"
1797 # - "`undeliverableShippingAddress`"
1798 # - "`unsupportedPoBoxAddress`"
1799 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1800 "reasonText": "A String", # The explanation of the reason.
1801 "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
1802 "quantity": 42, # The quantity to return and refund.
1803 "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
1804 }
1805
1806
1807Returns:
1808 An object of the form:
1809
1810 {
1811 "kind": "content#ordersInStoreRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".
1812 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1813 #
1814 # Acceptable values are:
1815 # - "`duplicate`"
1816 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1817 }</pre>
1818</div>
1819
1820<div class="method">
1821 <code class="details" id="list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</code>
1822 <pre>Lists the orders in your Merchant Center account.
1823
1824Args:
1825 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
1826 orderBy: string, Order results by placement date in descending or ascending order.
1827
1828Acceptable values are:
1829- placedDateAsc
1830- placedDateDesc
1831 pageToken: string, The token returned by the previous request.
1832 placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
1833 acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1834We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1835 maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
1836 placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1837 statuses: string, Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`. (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1838 Allowed values
1839 active -
1840 canceled -
1841 completed -
1842 delivered -
1843 inProgress -
1844 partiallyDelivered -
1845 partiallyReturned -
1846 partiallyShipped -
1847 pendingShipment -
1848 returned -
1849 shipped -
1850
1851Returns:
1852 An object of the form:
1853
1854 {
1855 "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
1856 "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
1857 "resources": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1858 { # Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1859 "customer": { # The details of the customer who placed the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1860 "loyaltyInfo": { # Loyalty program information.
1861 "loyaltyNumber": "A String", # The loyalty card/membership number.
1862 "name": "A String", # Name of card/membership holder, this field will be populated when
1863 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1864 "fullName": "A String", # Full name of the customer.
1865 "marketingRightsInfo": { # Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1866 "explicitMarketingPreference": "A String", # Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.
1867 #
1868 # Acceptable values are:
1869 # - "`denied`"
1870 # - "`granted`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1871 "lastUpdatedTimestamp": "A String", # Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1872 "marketingEmailAddress": "A String", # Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1873 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1874 "invoiceReceivingEmail": "A String", # Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1875 },
1876 "promotions": [ # Promotions associated with the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1877 #
1878 # To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.
1879 #
1880 # Examples:
1881 # - To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`.
1882 # - To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item.
1883 #
1884 # Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price.
1885 #
1886 # More details about the program are here.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1887 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1888 "shortTitle": "A String", # A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.
1889 "title": "A String", # Required. The title of the promotion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1890 "priceValue": { # Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
1891 "currency": "A String", # The currency of the price.
1892 "value": "A String", # The price represented as a number.
1893 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1894 "taxValue": { # Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1895 "currency": "A String", # The currency of the price.
1896 "value": "A String", # The price represented as a number.
1897 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1898 "merchantPromotionId": "A String", # Required. This field is used to identify promotions within merchants' own systems.
1899 "subtype": "A String", # Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.
1900 #
1901 # Acceptable values are:
1902 # - "`buyMGetMoneyOff`"
1903 # - "`buyMGetNMoneyOff`"
1904 # - "`buyMGetNPercentOff`"
1905 # - "`buyMGetPercentOff`"
1906 # - "`freeGift`"
1907 # - "`freeGiftWithItemId`"
1908 # - "`freeGiftWithValue`"
1909 # - "`freeShippingOvernight`"
1910 # - "`freeShippingStandard`"
1911 # - "`freeShippingTwoDay`"
1912 # - "`moneyOff`"
1913 # - "`percentOff`"
1914 # - "`rewardPoints`"
1915 # - "`salePrice`"
1916 "startTime": "A String", # Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1917 "appliedItems": [ # Items which this promotion have been applied to. Do not provide for `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1918 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1919 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1920 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1921 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1922 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1923 },
1924 ],
1925 "applicableItems": [ # Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.
1926 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1927 "quantity": 42, # The quantity of the associated product. Do not provide for `orders.createtestorder`.
1928 "offerId": "A String", # Required. Offer ID of a product. Only for `orders.createtestorder`.
1929 "lineItemId": "A String", # The line item ID of a product. Do not provide for `orders.createtestorder`.
1930 "productId": "A String", # `orders.createtestorder`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1931 },
1932 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1933 "endTime": "A String", # Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
1934 "type": "A String", # Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.
1935 #
1936 # Acceptable values are:
1937 # - "`product`"
1938 # - "`shipping`"
1939 "funder": "A String", # Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.
1940 #
1941 # Acceptable values are:
1942 # - "`google`"
1943 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1944 },
1945 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1946 "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "`content#order`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1947 "shippingCostTax": { # The tax for the total shipping cost.
1948 "currency": "A String", # The currency of the price.
1949 "value": "A String", # The price represented as a number.
1950 },
1951 "shipments": [ # Shipments of the order.
1952 {
1953 "status": "A String", # The status of the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1954 #
1955 # Acceptable values are:
1956 # - "`delivered`"
1957 # - "`readyForPickup`"
1958 # - "`shipped`"
1959 # - "`undeliverable`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1960 "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1961 "shipmentGroupId": "A String", # The shipment group ID of the shipment. This is set in shiplineitems request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1962 "carrier": "A String", # The carrier handling the shipment.
1963 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1964 # For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates.
1965 # Supported carriers for US are:
1966 # - "`ups`" (United Parcel Service) automatic status updates
1967 # - "`usps`" (United States Postal Service) automatic status updates
1968 # - "`fedex`" (FedEx) automatic status updates
1969 # - "`dhl`" (DHL eCommerce) automatic status updates (US only)
1970 # - "`ontrac`" (OnTrac) automatic status updates
1971 # - "`dhl express`" (DHL Express)
1972 # - "`deliv`" (Deliv)
1973 # - "`dynamex`" (TForce)
1974 # - "`lasership`" (LaserShip)
1975 # - "`mpx`" (Military Parcel Xpress)
1976 # - "`uds`" (United Delivery Service)
1977 # - "`efw`" (Estes Forwarding Worldwide)
1978 # - "`jd logistics`" (JD Logistics)
1979 # - "`yunexpress`" (YunExpress)
1980 # - "`china post`" (China Post)
1981 # - "`china ems`" (China Post Express Mail Service)
1982 # - "`singapore post`" (Singapore Post)
1983 # - "`pos malaysia`" (Pos Malaysia)
1984 # - "`postnl`" (PostNL)
1985 # - "`ptt`" (PTT Turkish Post)
1986 # - "`eub`" (ePacket)
1987 # - "`chukou1`" (Chukou1 Logistics)
1988 # Supported carriers for FR are:
1989 # - "`la poste`" (La Poste) automatic status updates
1990 # - "`colissimo`" (Colissimo by La Poste) automatic status updates
1991 # - "`ups`" (United Parcel Service) automatic status updates
1992 # - "`chronopost`" (Chronopost by La Poste)
1993 # - "`gls`" (General Logistics Systems France)
1994 # - "`dpd`" (DPD Group by GeoPost)
1995 # - "`bpost`" (Belgian Post Group)
1996 # - "`colis prive`" (Colis Privé)
1997 # - "`boxtal`" (Boxtal)
1998 # - "`geodis`" (GEODIS)
1999 # - "`tnt`" (TNT)
2000 # - "`db schenker`" (DB Schenker)
2001 # - "`aramex`" (Aramex)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2002 "trackingId": "A String", # The tracking ID for the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2003 "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2004 "lineItems": [ # The line items that are shipped.
2005 {
2006 "quantity": 42, # The quantity that is shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2007 "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2008 "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
2009 },
2010 ],
2011 "id": "A String", # The ID of the shipment.
2012 },
2013 ],
2014 "refunds": [ # Refunds for the order.
2015 {
2016 "amount": { # The amount that is refunded.
2017 "currency": "A String", # The currency of the price.
2018 "value": "A String", # The price represented as a number.
2019 },
2020 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
2021 "reason": "A String", # The reason for the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2022 #
2023 # Acceptable values are:
2024 # - "`adjustment`"
2025 # - "`autoPostInternal`"
2026 # - "`autoPostInvalidBillingAddress`"
2027 # - "`autoPostNoInventory`"
2028 # - "`autoPostPriceError`"
2029 # - "`autoPostUndeliverableShippingAddress`"
2030 # - "`couponAbuse`"
2031 # - "`courtesyAdjustment`"
2032 # - "`customerCanceled`"
2033 # - "`customerDiscretionaryReturn`"
2034 # - "`customerInitiatedMerchantCancel`"
2035 # - "`customerSupportRequested`"
2036 # - "`deliveredLateByCarrier`"
2037 # - "`deliveredTooLate`"
2038 # - "`expiredItem`"
2039 # - "`failToPushOrderGoogleError`"
2040 # - "`failToPushOrderMerchantError`"
2041 # - "`failToPushOrderMerchantFulfillmentError`"
2042 # - "`failToPushOrderToMerchant`"
2043 # - "`failToPushOrderToMerchantOutOfStock`"
2044 # - "`feeAdjustment`"
2045 # - "`invalidCoupon`"
2046 # - "`lateShipmentCredit`"
2047 # - "`malformedShippingAddress`"
2048 # - "`merchantDidNotShipOnTime`"
2049 # - "`noInventory`"
2050 # - "`orderTimeout`"
2051 # - "`other`"
2052 # - "`paymentAbuse`"
2053 # - "`paymentDeclined`"
2054 # - "`priceAdjustment`"
2055 # - "`priceError`"
2056 # - "`productArrivedDamaged`"
2057 # - "`productNotAsDescribed`"
2058 # - "`promoReallocation`"
2059 # - "`qualityNotAsExpected`"
2060 # - "`returnRefundAbuse`"
2061 # - "`shippingCostAdjustment`"
2062 # - "`shippingPriceError`"
2063 # - "`taxAdjustment`"
2064 # - "`taxError`"
2065 # - "`undeliverableShippingAddress`"
2066 # - "`unsupportedPoBoxAddress`"
2067 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2068 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2069 #
2070 # Acceptable values are:
2071 # - "`customer`"
2072 # - "`googleBot`"
2073 # - "`googleCustomerService`"
2074 # - "`googlePayments`"
2075 # - "`googleSabre`"
2076 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2077 "reasonText": "A String", # The explanation of the reason.
2078 },
2079 ],
2080 "taxCollector": "A String", # The party responsible for collecting and remitting taxes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2081 #
2082 # Acceptable values are:
2083 # - "`marketplaceFacilitator`"
2084 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2085 "acknowledged": True or False, # Whether the order was acknowledged.
2086 "paymentStatus": "A String", # The status of the payment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2087 #
2088 # Acceptable values are:
2089 # - "`paymentCaptured`"
2090 # - "`paymentRejected`"
2091 # - "`paymentSecured`"
2092 # - "`pendingAuthorization`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2093 "merchantId": "A String",
2094 "merchantOrderId": "A String", # Merchant-provided ID of the order.
2095 "status": "A String", # The status of the order.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2096 #
2097 # Acceptable values are:
2098 # - "`canceled`"
2099 # - "`delivered`"
2100 # - "`inProgress`"
2101 # - "`partiallyDelivered`"
2102 # - "`partiallyReturned`"
2103 # - "`partiallyShipped`"
2104 # - "`pendingShipment`"
2105 # - "`returned`"
2106 # - "`shipped`"
2107 "pickupDetails": { # Pickup details for shipments of type `pickup`.
2108 "locationId": "A String", # ID of the pickup location.
2109 "collectors": [ # Collectors authorized to pick up shipment from the pickup location.
2110 {
2111 "phoneNumber": "A String", # Phone number of the person picking up the shipment.
2112 "name": "A String", # Name of the person picking up the shipment.
2113 },
2114 ],
2115 "address": { # Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.
2116 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
2117 "country": "A String", # CLDR country code (e.g. "US").
2118 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
2119 # John Smith
2120 # 1600 Amphitheatre Parkway
2121 # Mountain View, CA, 94043
2122 # United States
2123 "A String",
2124 ],
2125 "streetAddress": [ # Street-level part of the address.
2126 "A String",
2127 ],
2128 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
2129 "recipientName": "A String", # Name of the recipient.
2130 "isPostOfficeBox": True or False, # Whether the address is a post office box.
2131 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
2132 },
2133 },
2134 "netTaxAmount": { # The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2135 "currency": "A String", # The currency of the price.
2136 "value": "A String", # The price represented as a number.
2137 },
2138 "billingAddress": { # The billing address.
2139 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
2140 "country": "A String", # CLDR country code (e.g. "US").
2141 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
2142 # John Smith
2143 # 1600 Amphitheatre Parkway
2144 # Mountain View, CA, 94043
2145 # United States
2146 "A String",
2147 ],
2148 "streetAddress": [ # Street-level part of the address.
2149 "A String",
2150 ],
2151 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
2152 "recipientName": "A String", # Name of the recipient.
2153 "isPostOfficeBox": True or False, # Whether the address is a post office box.
2154 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
2155 },
2156 "netPriceAmount": { # The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.
2157 "currency": "A String", # The currency of the price.
2158 "value": "A String", # The price represented as a number.
2159 },
2160 "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
2161 "lineItems": [ # Line items that are ordered.
2162 {
2163 "product": { # Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
2164 "targetCountry": "A String", # The CLDR territory code of the target country of the product.
2165 "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
2166 "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
2167 "title": "A String", # The title of the product.
2168 "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
2169 "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.
2170 {
2171 "dimension": "A String", # The dimension of the variant.
2172 "value": "A String", # The value for the dimension.
2173 },
2174 ],
2175 "brand": "A String", # Brand of the item.
2176 "itemGroupId": "A String", # Shared identifier for all variants of the same product.
2177 "offerId": "A String", # An identifier of the item.
2178 "price": { # Price of the item.
2179 "currency": "A String", # The currency of the price.
2180 "value": "A String", # The price represented as a number.
2181 },
2182 "imageLink": "A String", # URL of an image of the item.
2183 "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
2184 "fees": [ # Associated fees at order creation time.
2185 {
2186 "amount": { # Amount of the fee.
2187 "currency": "A String", # The currency of the price.
2188 "value": "A String", # The price represented as a number.
2189 },
2190 "name": "A String", # Name of the fee.
2191 },
2192 ],
2193 "id": "A String", # The REST ID of the product.
2194 "condition": "A String", # Condition or state of the item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2195 #
2196 # Acceptable values are:
2197 # - "`new`"
2198 # - "`refurbished`"
2199 # - "`used`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2200 },
2201 "quantityPending": 42, # Number of items pending.
2202 "quantityDelivered": 42, # Number of items delivered.
2203 "returnInfo": { # Details of the return policy for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2204 "policyUrl": "A String", # Required. URL of the item return policy.
2205 "isReturnable": True or False, # Required. Whether the item is returnable.
2206 "daysToReturn": 42, # Required. How many days later the item can be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2207 },
2208 "quantityOrdered": 42, # Number of items ordered.
2209 "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
2210 "currency": "A String", # The currency of the price.
2211 "value": "A String", # The price represented as a number.
2212 },
2213 "adjustments": [ # Price and tax adjustments applied on the line item.
2214 {
2215 "type": "A String", # Type of this adjustment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2216 #
2217 # Acceptable values are:
2218 # - "`promotion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2219 "priceAdjustment": { # Adjustment for total price of the line item.
2220 "currency": "A String", # The currency of the price.
2221 "value": "A String", # The price represented as a number.
2222 },
2223 "taxAdjustment": { # Adjustment for total tax of the line item.
2224 "currency": "A String", # The currency of the price.
2225 "value": "A String", # The price represented as a number.
2226 },
2227 },
2228 ],
2229 "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
2230 "currency": "A String", # The currency of the price.
2231 "value": "A String", # The price represented as a number.
2232 },
2233 "cancellations": [ # Cancellations of the line item.
2234 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2235 "reason": "A String", # The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.
2236 #
2237 # Acceptable values are:
2238 # - "`autoPostInternal`"
2239 # - "`autoPostInvalidBillingAddress`"
2240 # - "`autoPostNoInventory`"
2241 # - "`autoPostPriceError`"
2242 # - "`autoPostUndeliverableShippingAddress`"
2243 # - "`couponAbuse`"
2244 # - "`customerCanceled`"
2245 # - "`customerInitiatedCancel`"
2246 # - "`customerSupportRequested`"
2247 # - "`failToPushOrderGoogleError`"
2248 # - "`failToPushOrderMerchantError`"
2249 # - "`failToPushOrderMerchantFulfillmentError`"
2250 # - "`failToPushOrderToMerchant`"
2251 # - "`failToPushOrderToMerchantOutOfStock`"
2252 # - "`invalidCoupon`"
2253 # - "`malformedShippingAddress`"
2254 # - "`merchantDidNotShipOnTime`"
2255 # - "`noInventory`"
2256 # - "`orderTimeout`"
2257 # - "`other`"
2258 # - "`paymentAbuse`"
2259 # - "`paymentDeclined`"
2260 # - "`priceError`"
2261 # - "`returnRefundAbuse`"
2262 # - "`shippingPriceError`"
2263 # - "`taxError`"
2264 # - "`undeliverableShippingAddress`"
2265 # - "`unsupportedPoBoxAddress`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2266 "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
2267 "reasonText": "A String", # The explanation of the reason.
2268 "actor": "A String", # The actor that created the cancellation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2269 #
2270 # Acceptable values are:
2271 # - "`customer`"
2272 # - "`googleBot`"
2273 # - "`googleCustomerService`"
2274 # - "`googlePayments`"
2275 # - "`googleSabre`"
2276 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2277 "quantity": 42, # The quantity that was canceled.
2278 },
2279 ],
2280 "quantityCanceled": 42, # Number of items canceled.
2281 "annotations": [ # Annotations that are attached to the line item.
2282 {
2283 "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
2284 "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
2285 },
2286 ],
2287 "returns": [ # Returns of the line item.
2288 {
2289 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2290 #
2291 # Acceptable values are:
2292 # - "`customerDiscretionaryReturn`"
2293 # - "`customerInitiatedMerchantCancel`"
2294 # - "`deliveredTooLate`"
2295 # - "`expiredItem`"
2296 # - "`invalidCoupon`"
2297 # - "`malformedShippingAddress`"
2298 # - "`other`"
2299 # - "`productArrivedDamaged`"
2300 # - "`productNotAsDescribed`"
2301 # - "`qualityNotAsExpected`"
2302 # - "`undeliverableShippingAddress`"
2303 # - "`unsupportedPoBoxAddress`"
2304 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2305 "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
2306 "reasonText": "A String", # The explanation of the reason.
2307 "actor": "A String", # The actor that created the refund.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2308 #
2309 # Acceptable values are:
2310 # - "`customer`"
2311 # - "`googleBot`"
2312 # - "`googleCustomerService`"
2313 # - "`googlePayments`"
2314 # - "`googleSabre`"
2315 # - "`merchant`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2316 "quantity": 42, # Quantity that is returned.
2317 },
2318 ],
2319 "quantityShipped": 42, # Number of items shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2320 "quantityReadyForPickup": 42, # Number of items ready for pickup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2321 "quantityReturned": 42, # Number of items returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2322 "quantityUndeliverable": 42, # Number of items undeliverable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2323 "id": "A String", # The ID of the line item.
2324 "shippingDetails": { # Details of the requested shipping for the line item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2325 "deliverByDate": "A String", # Required. The delivery by date, in ISO 8601 format.
2326 "type": "A String", # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.
2327 #
2328 # Acceptable values are:
2329 # - "`delivery`"
2330 # - "`pickup`"
2331 "method": { # Required. Details of the shipping method.
2332 "minDaysInTransit": 42, # Required. Minimum transit time.
2333 "carrier": "A String", # The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.
2334 "methodName": "A String", # Required. The name of the shipping method.
2335 "maxDaysInTransit": 42, # Required. Maximum transit time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2336 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2337 "shipByDate": "A String", # Required. The ship by date, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2338 },
2339 },
2340 ],
2341 "shippingCost": { # The total cost of shipping for all items.
2342 "currency": "A String", # The currency of the price.
2343 "value": "A String", # The price represented as a number.
2344 },
2345 "id": "A String", # The REST ID of the order. Globally unique.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2346 "deliveryDetails": { # Delivery details for shipments of type `delivery`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2347 "phoneNumber": "A String", # The phone number of the person receiving the delivery.
2348 "address": { # The delivery address
2349 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
2350 "country": "A String", # CLDR country code (e.g. "US").
2351 "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
2352 # John Smith
2353 # 1600 Amphitheatre Parkway
2354 # Mountain View, CA, 94043
2355 # United States
2356 "A String",
2357 ],
2358 "streetAddress": [ # Street-level part of the address.
2359 "A String",
2360 ],
2361 "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
2362 "recipientName": "A String", # Name of the recipient.
2363 "isPostOfficeBox": True or False, # Whether the address is a post office box.
2364 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
2365 },
2366 },
2367 },
2368 ],
2369 }</pre>
2370</div>
2371
2372<div class="method">
2373 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2374 <pre>Retrieves the next page of results.
2375
2376Args:
2377 previous_request: The request for the previous page. (required)
2378 previous_response: The response from the request for the previous page. (required)
2379
2380Returns:
2381 A request object that you can call 'execute()' on to request the next
2382 page. Returns None if there are no more items in the collection.
2383 </pre>
2384</div>
2385
2386<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2387 <code class="details" id="rejectreturnlineitem">rejectreturnlineitem(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2388 <pre>Rejects return on an line item.
2389
2390Args:
2391 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2392 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2393 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2394 The object takes the form of:
2395
2396{
2397 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2398 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2399 #
2400 # Acceptable values are:
2401 # - "`damagedOrUsed`"
2402 # - "`missingComponent`"
2403 # - "`notEligible`"
2404 # - "`other`"
2405 # - "`outOfReturnWindow`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2406 "reasonText": "A String", # The explanation of the reason.
2407 "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
2408 "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
2409 "quantity": 42, # The quantity to return and refund.
2410 }
2411
2412
2413Returns:
2414 An object of the form:
2415
2416 {
2417 "kind": "content#ordersRejectReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".
2418 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2419 #
2420 # Acceptable values are:
2421 # - "`duplicate`"
2422 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2423 }</pre>
2424</div>
2425
2426<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2427 <code class="details" id="returnrefundlineitem">returnrefundlineitem(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2428 <pre>Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
2429
2430Args:
2431 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2432 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2433 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2434 The object takes the form of:
2435
2436{
2437 "priceAmount": { # The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed.
2438 "currency": "A String", # The currency of the price.
2439 "value": "A String", # The price represented as a number.
2440 },
2441 "taxAmount": { # The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided.
2442 "currency": "A String", # The currency of the price.
2443 "value": "A String", # The price represented as a number.
2444 },
2445 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2446 "reason": "A String", # The reason for the return.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2447 #
2448 # Acceptable values are:
2449 # - "`customerDiscretionaryReturn`"
2450 # - "`customerInitiatedMerchantCancel`"
2451 # - "`deliveredTooLate`"
2452 # - "`expiredItem`"
2453 # - "`invalidCoupon`"
2454 # - "`malformedShippingAddress`"
2455 # - "`other`"
2456 # - "`productArrivedDamaged`"
2457 # - "`productNotAsDescribed`"
2458 # - "`qualityNotAsExpected`"
2459 # - "`undeliverableShippingAddress`"
2460 # - "`unsupportedPoBoxAddress`"
2461 # - "`wrongProductShipped`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2462 "reasonText": "A String", # The explanation of the reason.
2463 "lineItemId": "A String", # The ID of the line item to return. Either lineItemId or productId is required.
2464 "quantity": 42, # The quantity to return and refund.
2465 "productId": "A String", # The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
2466 }
2467
2468
2469Returns:
2470 An object of the form:
2471
2472 {
2473 "kind": "content#ordersReturnRefundLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".
2474 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2475 #
2476 # Acceptable values are:
2477 # - "`duplicate`"
2478 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2479 }</pre>
2480</div>
2481
2482<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2483 <code class="details" id="setlineitemmetadata">setlineitemmetadata(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2484 <pre>Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.
2485
2486Args:
2487 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2488 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2489 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2490 The object takes the form of:
2491
2492{
2493 "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
2494 "annotations": [
2495 {
2496 "value": "A String", # Value for additional merchant provided (as key-value pairs) annotation about the line item.
2497 "key": "A String", # Key for additional merchant provided (as key-value pairs) annotation about the line item.
2498 },
2499 ],
2500 "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
2501 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2502 }
2503
2504
2505Returns:
2506 An object of the form:
2507
2508 {
2509 "kind": "content#ordersSetLineItemMetadataResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".
2510 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2511 #
2512 # Acceptable values are:
2513 # - "`duplicate`"
2514 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2515 }</pre>
2516</div>
2517
2518<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2519 <code class="details" id="shiplineitems">shiplineitems(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2520 <pre>Marks line item(s) as shipped.
2521
2522Args:
2523 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2524 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2525 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2526 The object takes the form of:
2527
2528{
2529 "lineItems": [ # Line items to ship.
2530 {
2531 "quantity": 42, # The quantity that is shipped.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2532 "lineItemId": "A String", # The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2533 "productId": "A String", # The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
2534 },
2535 ],
2536 "shipmentInfos": [ # Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
2537 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2538 "carrier": "A String", # The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2539 "trackingId": "A String", # The tracking ID for the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2540 "shipmentId": "A String", # Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2541 },
2542 ],
2543 "shipmentGroupId": "A String", # ID of the shipment group. Required for orders that use the orderinvoices service.
2544 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2545 }
2546
2547
2548Returns:
2549 An object of the form:
2550
2551 {
2552 "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
2553 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2554 #
2555 # Acceptable values are:
2556 # - "`duplicate`"
2557 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2558 }</pre>
2559</div>
2560
2561<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2562 <code class="details" id="updatelineitemshippingdetails">updatelineitemshippingdetails(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2563 <pre>Updates ship by and delivery by dates for a line item.
2564
2565Args:
2566 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2567 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2568 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2569 The object takes the form of:
2570
2571{
2572 "deliverByDate": "A String", # Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.
2573 #
2574 # Provided date should be within 1 year timeframe and can not be a date in the past.
2575 "shipByDate": "A String", # Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.
2576 #
2577 # Provided date should be within 1 year timeframe and can not be a date in the past.
2578 "productId": "A String", # The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.
2579 "lineItemId": "A String", # The ID of the line item to set metadata. Either lineItemId or productId is required.
2580 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2581 }
2582
2583
2584Returns:
2585 An object of the form:
2586
2587 {
2588 "kind": "content#ordersUpdateLineItemShippingDetailsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".
2589 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2590 #
2591 # Acceptable values are:
2592 # - "`duplicate`"
2593 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2594 }</pre>
2595</div>
2596
2597<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2598 <code class="details" id="updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2599 <pre>Updates the merchant order ID for a given order.
2600
2601Args:
2602 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2603 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2604 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2605 The object takes the form of:
2606
2607{
2608 "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
2609 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2610 }
2611
2612
2613Returns:
2614 An object of the form:
2615
2616 {
2617 "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
2618 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2619 #
2620 # Acceptable values are:
2621 # - "`duplicate`"
2622 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2623 }</pre>
2624</div>
2625
2626<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2627 <code class="details" id="updateshipment">updateshipment(merchantId, orderId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2628 <pre>Updates a shipment's status, carrier, and/or tracking ID.
2629
2630Args:
2631 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
2632 orderId: string, The ID of the order. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2633 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2634 The object takes the form of:
2635
2636{
2637 "status": "A String", # New status for the shipment. Not updated if missing.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2638 #
2639 # Acceptable values are:
2640 # - "`delivered`"
2641 # - "`undeliverable`"
2642 "carrier": "A String", # The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2643 "trackingId": "A String", # The tracking ID for the shipment. Not updated if missing.
2644 "shipmentId": "A String", # The ID of the shipment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2645 "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2646 "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
2647 }
2648
2649
2650Returns:
2651 An object of the form:
2652
2653 {
2654 "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
2655 "executionStatus": "A String", # The status of the execution.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2656 #
2657 # Acceptable values are:
2658 # - "`duplicate`"
2659 # - "`executed`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2660 }</pre>
2661</div>
2662
2663</body></html>