google_api_content v0.1.0 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 non-facilitated payment orders

Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders

Link to this section Functions

Link to this function content_orderinvoices_createchargeinvoice(connection, merchant_id, order_id, opts \\ []) View Source
content_orderinvoices_createchargeinvoice(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.OrderinvoicesCreateChargeInvoiceResponse.t()}
  | {:error, Tesla.Env.t()}

Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderinvoicesCreateChargeInvoiceRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderinvoicesCreateChargeInvoiceResponse{}} on success {:error, info} on failure

Link to this function content_orderinvoices_createrefundinvoice(connection, merchant_id, order_id, opts \\ []) View Source
content_orderinvoices_createrefundinvoice(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.OrderinvoicesCreateRefundInvoiceResponse.t()}
  | {:error, Tesla.Env.t()}

Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderinvoicesCreateRefundInvoiceRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderinvoicesCreateRefundInvoiceResponse{}} on success {:error, info} on failure