content.orderinvoices.createrefundinvoice

POST {{baseUrl}}/content/v2/:merchantId/orderinvoices/:orderId/createRefundInvoice?$.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 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.

Request Params

Key	Datatype	Description
`$.xgafv`	string	V1 error format.
`access_token`	string	OAuth access token.
`alt`	string	Data format for response.
`callback`	string	JSONP
`fields`	string	Selector specifying which fields to include in a partial response.
`key`	string	API 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_token`	string	OAuth 2.0 token for the current user.
`prettyPrint`	string	Returns response with indentations and line breaks.
`quotaUser`	string	Available 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_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"invoiceId"=>"<string>", "operationId"=>"<string>", "refundOnlyOption"=>{"description"=>"<string>", "reason"=>"<string>"}, "returnOption"=>{"description"=>"<string>", "reason"=>"<string>"}, "shipmentInvoices"=>[{"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>"}]}}], "shipmentGroupId"=>"<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>"}]}}], "shipmentGroupId"=>"<string>"}]}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;executionStatus&quot;:&quot;nisi&quot;,&quot;kind&quot;:&quot;ipsum aute&quot;}