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