content.orderinvoices.createchargeinvoice

POST {{baseUrl}}/content/v2/:merchantId/orderinvoices/:orderId/createChargeInvoice?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.

Request Params

KeyDatatypeRequiredDescription
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"invoiceId"=>"<string>", "invoiceSummary"=>{"additionalChargeSummaries"=>[{"totalAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "type"=>"<string>"}, {"totalAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "type"=>"<string>"}], "customerBalance"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "googleBalance"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "merchantBalance"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "productTotal"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionSummaries"=>[{"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}, {"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}]}, "lineItemInvoices"=>[{"lineItemId"=>"<string>", "productId"=>"<string>", "shipmentUnitIds"=>["<string>", "<string>"], "unitInvoice"=>{"additionalCharges"=>[{"additionalChargeAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "additionalChargePromotions"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "type"=>"<string>"}, {"additionalChargeAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "additionalChargePromotions"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "type"=>"<string>"}], "promotions"=>[{"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}, {"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}], "unitPricePretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "unitPriceTaxes"=>[{"taxAmount"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "taxName"=>"<string>", "taxType"=>"<string>"}, {"taxAmount"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "taxName"=>"<string>", "taxType"=>"<string>"}]}}, {"lineItemId"=>"<string>", "productId"=>"<string>", "shipmentUnitIds"=>["<string>", "<string>"], "unitInvoice"=>{"additionalCharges"=>[{"additionalChargeAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "additionalChargePromotions"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "type"=>"<string>"}, {"additionalChargeAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "additionalChargePromotions"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "type"=>"<string>"}], "promotions"=>[{"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}, {"promotionAmount"=>{"pretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "tax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "promotionId"=>"<string>"}], "unitPricePretax"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "unitPriceTaxes"=>[{"taxAmount"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "taxName"=>"<string>", "taxType"=>"<string>"}, {"taxAmount"=>{"currency"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "taxName"=>"<string>", "taxType"=>"<string>"}]}}], "operationId"=>"<string>", "shipmentGroupId"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;executionStatus&quot;:&quot;commodo exercitation culpa&quot;,&quot;kind&quot;:&quot;consequat&quot;}