- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- OrderinvoicesCreateRefundInvoiceRequest
- OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption
- ShipmentInvoice
- OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption
- Try it!
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.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orderinvoices/{orderId}/createRefundInvoice
Path parameters
Parameters | |
---|---|
merchantId |
The ID of the account that manages the order. This cannot be a multi-client account. |
orderId |
The ID of the order. |
Request body
The request body contains an instance of OrderinvoicesCreateRefundInvoiceRequest
.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "executionStatus": string, "kind": string } |
Fields | |
---|---|
executionStatus |
The status of the execution. Acceptable values are:
|
kind |
Identifies what kind of resource this is. Value: the fixed string " |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
OrderinvoicesCreateRefundInvoiceRequest
JSON representation |
---|
{ "invoiceId": string, "operationId": string, "refundOnlyOption": { object ( |
Fields | |
---|---|
invoiceId |
[required] The ID of the invoice. |
operationId |
[required] The ID of the operation, unique across all operations for a given order. |
refundOnlyOption |
Option to create a refund-only invoice. Exactly one of |
shipmentInvoices[] |
Invoice details for different shipment groups. |
returnOption |
Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of |
OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption
JSON representation |
---|
{ "reason": string, "description": string } |
Fields | |
---|---|
reason |
[required] Reason for the refund. Acceptable values are:
|
description |
Optional description of the refund reason. |
ShipmentInvoice
JSON representation |
---|
{ "shipmentGroupId": string, "lineItemInvoices": [ { object ( |
Fields | |
---|---|
shipmentGroupId |
[required] ID of the shipment group. It is assigned by the merchant in the |
lineItemInvoices[] |
[required] Invoice details per line item. |
invoiceSummary |
[required] Invoice summary. |
OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption
JSON representation |
---|
{ "reason": string, "description": string } |
Fields | |
---|---|
reason |
[required] Reason for the return. Acceptable values are:
|
description |
Optional description of the return reason. |