1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.orderinvoices.html">orderinvoices</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#createchargeinvoice">createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.</p> 83<p class="toc_element"> 84 <code><a href="#createrefundinvoice">createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="createchargeinvoice">createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)</code> 94 <pre>Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. 95 96Args: 97 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) 98 orderId: string, The ID of the order. (required) 99 body: object, The request body. 100 The object takes the form of: 101 102{ 103 "invoiceId": "A String", # [required] The ID of the invoice. 104 "invoiceSummary": { # [required] Invoice summary. 105 "additionalChargeSummaries": [ # Summary of the total amounts of the additional charges. 106 { 107 "totalAmount": { # [required] Total additional charge for this type. 108 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 109 "currency": "A String", # The currency of the price. 110 "value": "A String", # The price represented as a number. 111 }, 112 "taxAmount": { # [required] Tax value. 113 "currency": "A String", # The currency of the price. 114 "value": "A String", # The price represented as a number. 115 }, 116 }, 117 "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`" 118 }, 119 ], 120 "productTotal": { # [required] Total price for the product. 121 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 122 "currency": "A String", # The currency of the price. 123 "value": "A String", # The price represented as a number. 124 }, 125 "taxAmount": { # [required] Tax value. 126 "currency": "A String", # The currency of the price. 127 "value": "A String", # The price represented as a number. 128 }, 129 }, 130 }, 131 "lineItemInvoices": [ # [required] Invoice details per line item. 132 { 133 "lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set. 134 "productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. 135 "shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). 136 "A String", 137 ], 138 "unitInvoice": { # [required] Invoice details for a single unit. 139 "additionalCharges": [ # Additional charges for a unit, e.g. shipping costs. 140 { 141 "additionalChargeAmount": { # [required] Amount of the additional charge per unit. *Note:* Invoicing works on a per unit bases. The `additionalChargeAmount` is the amount charged per unit, and will be multiplied by the number of entries in `shipmentUnitID`. 142 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 143 "currency": "A String", # The currency of the price. 144 "value": "A String", # The price represented as a number. 145 }, 146 "taxAmount": { # [required] Tax value. 147 "currency": "A String", # The currency of the price. 148 "value": "A String", # The price represented as a number. 149 }, 150 }, 151 "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`" 152 }, 153 ], 154 "unitPrice": { # [required] Pre-tax or post-tax price of one unit depending on the locality of the order. *Note:* Invoicing works on a per unit basis. The `unitPrice` is the price of a single unit, and will be multiplied by the number of entries in `shipmentUnitId`. 155 "currency": "A String", # The currency of the price. 156 "value": "A String", # The price represented as a number. 157 }, 158 "unitPriceTaxes": [ # Tax amounts to apply to the unit price. 159 { 160 "taxAmount": { # [required] Tax amount for the tax type. 161 "currency": "A String", # The currency of the price. 162 "value": "A String", # The price represented as a number. 163 }, 164 "taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`. 165 "taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`" 166 }, 167 ], 168 }, 169 }, 170 ], 171 "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order. 172 "shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. 173} 174 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { 184 "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`" 185 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderinvoicesCreateChargeInvoiceResponse`". 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="createrefundinvoice">createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)</code> 191 <pre>Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice. 192 193Args: 194 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) 195 orderId: string, The ID of the order. (required) 196 body: object, The request body. 197 The object takes the form of: 198 199{ 200 "invoiceId": "A String", # [required] The ID of the invoice. 201 "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order. 202 "refundOnlyOption": { # Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided. 203 "description": "A String", # Optional description of the refund reason. 204 "reason": "A String", # [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" 205 }, 206 "returnOption": { # Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided. 207 "description": "A String", # Optional description of the return reason. 208 "reason": "A String", # [required] Reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" 209 }, 210 "shipmentInvoices": [ # Invoice details for different shipment groups. 211 { 212 "invoiceSummary": { # [required] Invoice summary. 213 "additionalChargeSummaries": [ # Summary of the total amounts of the additional charges. 214 { 215 "totalAmount": { # [required] Total additional charge for this type. 216 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 217 "currency": "A String", # The currency of the price. 218 "value": "A String", # The price represented as a number. 219 }, 220 "taxAmount": { # [required] Tax value. 221 "currency": "A String", # The currency of the price. 222 "value": "A String", # The price represented as a number. 223 }, 224 }, 225 "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`" 226 }, 227 ], 228 "productTotal": { # [required] Total price for the product. 229 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 230 "currency": "A String", # The currency of the price. 231 "value": "A String", # The price represented as a number. 232 }, 233 "taxAmount": { # [required] Tax value. 234 "currency": "A String", # The currency of the price. 235 "value": "A String", # The price represented as a number. 236 }, 237 }, 238 }, 239 "lineItemInvoices": [ # [required] Invoice details per line item. 240 { 241 "lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set. 242 "productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. 243 "shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). 244 "A String", 245 ], 246 "unitInvoice": { # [required] Invoice details for a single unit. 247 "additionalCharges": [ # Additional charges for a unit, e.g. shipping costs. 248 { 249 "additionalChargeAmount": { # [required] Amount of the additional charge per unit. *Note:* Invoicing works on a per unit bases. The `additionalChargeAmount` is the amount charged per unit, and will be multiplied by the number of entries in `shipmentUnitID`. 250 "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order. 251 "currency": "A String", # The currency of the price. 252 "value": "A String", # The price represented as a number. 253 }, 254 "taxAmount": { # [required] Tax value. 255 "currency": "A String", # The currency of the price. 256 "value": "A String", # The price represented as a number. 257 }, 258 }, 259 "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`" 260 }, 261 ], 262 "unitPrice": { # [required] Pre-tax or post-tax price of one unit depending on the locality of the order. *Note:* Invoicing works on a per unit basis. The `unitPrice` is the price of a single unit, and will be multiplied by the number of entries in `shipmentUnitId`. 263 "currency": "A String", # The currency of the price. 264 "value": "A String", # The price represented as a number. 265 }, 266 "unitPriceTaxes": [ # Tax amounts to apply to the unit price. 267 { 268 "taxAmount": { # [required] Tax amount for the tax type. 269 "currency": "A String", # The currency of the price. 270 "value": "A String", # The price represented as a number. 271 }, 272 "taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`. 273 "taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`" 274 }, 275 ], 276 }, 277 }, 278 ], 279 "shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. 280 }, 281 ], 282} 283 284 x__xgafv: string, V1 error format. 285 Allowed values 286 1 - v1 error format 287 2 - v2 error format 288 289Returns: 290 An object of the form: 291 292 { 293 "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`" 294 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderinvoicesCreateRefundInvoiceResponse`". 295}</pre> 296</div> 297 298</body></html>