GoogleApi.Content.V2.Api.Orderreturns (google_api_content v0.58.1) View Source

API calls for all endpoints tagged Orderreturns.

Link to this section Summary

Link to this section Functions

Link to this function

content_orderreturns_get(connection, merchant_id, return_id, optional_params \\ [], opts \\ [])

View Source

Specs

content_orderreturns_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.MerchantOrderReturn.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an order return from your Merchant Center account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that manages the order. This cannot be a multi-client account.
  • return_id (type: String.t) - Merchant order return ID generated by Google.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V2.Model.MerchantOrderReturn{}} on success
  • {:error, info} on failure
Link to this function

content_orderreturns_list(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source

Specs

content_orderreturns_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.OrderreturnsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists order returns in your Merchant Center account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that manages the order. This cannot be a multi-client account.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :createdEndDate (type: String.t) - Obtains order returns created before this date (inclusively), in ISO 8601 format.
    • :createdStartDate (type: String.t) - Obtains order returns created after this date (inclusively), in ISO 8601 format.
    • :maxResults (type: integer()) - The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
    • :orderBy (type: String.t) - Return the results in the specified order.
    • :pageToken (type: String.t) - The token returned by the previous request.
  • opts (type: keyword()) - Call options

Returns

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