Method: orderinvoices.createchargeinvoice

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

HTTP request

POST https://www.googleapis.com/content/v2/{merchantId}/orderinvoices/{orderId}/createChargeInvoice

Path parameters

Parameters
merchantId

string

The ID of the account that manages the order. This cannot be a multi-client account.

orderId

string

The ID of the order.

Request body

The request body contains an instance of OrderinvoicesCreateChargeInvoiceRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "executionStatus": string,
  "kind": string
}
Fields
executionStatus

string

The status of the execution.

Acceptable values are:

  • "duplicate"
  • "executed"

kind

string

Identifies what kind of resource this is. Value: the fixed string

"content#orderinvoicesCreateChargeInvoiceResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content
  • https://www.googleapis.com/auth/structuredcontent

For more information, see the OAuth 2.0 Overview.

OrderinvoicesCreateChargeInvoiceRequest

JSON representation
{
  "invoiceId": string,
  "operationId": string,
  "shipmentGroupId": string,
  "lineItemInvoices": [
    {
      object (ShipmentInvoiceLineItemInvoice)
    }
  ],
  "invoiceSummary": {
    object (InvoiceSummary)
  }
}
Fields
invoiceId

string

[required] The ID of the invoice.

operationId

string

[required] The ID of the operation, unique across all operations for a given order.

shipmentGroupId

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.

lineItemInvoices[]

object (ShipmentInvoiceLineItemInvoice)

[required] Invoice details per line item.

invoiceSummary

object (InvoiceSummary)

[required] Invoice summary.