google_api_content v0.29.1 GoogleApi.Content.V2.Api.Orderinvoices View Source
API calls for all endpoints tagged Orderinvoices
.
Link to this section Summary
Functions
Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
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.
Link to this section Functions
content_orderinvoices_createchargeinvoice(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orderinvoices_createchargeinvoice( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.OrderinvoicesCreateChargeInvoiceResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_id
(type:String.t
) - The ID of the account that manages the order. This cannot be a multi-client account.order_id
(type:String.t
) - The ID of the order.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Content.V2.Model.OrderinvoicesCreateChargeInvoiceRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.OrderinvoicesCreateChargeInvoiceResponse{}}
on success{:error, info}
on failure
content_orderinvoices_createrefundinvoice(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orderinvoices_createrefundinvoice( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.OrderinvoicesCreateRefundInvoiceResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to servermerchant_id
(type:String.t
) - The ID of the account that manages the order. This cannot be a multi-client account.order_id
(type:String.t
) - The ID of the order.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Content.V2.Model.OrderinvoicesCreateRefundInvoiceRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V2.Model.OrderinvoicesCreateRefundInvoiceResponse{}}
on success{:error, info}
on failure