GoogleApi.Content.V2.Api.Orders (google_api_content v0.50.0) View Source

API calls for all endpoints tagged Orders.

Link to this section Summary

Functions

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

Sandbox only. Cancels a test order for customer-initiated cancellation.

Retrieves or modifies multiple orders in a single request.

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.

Link to this section Functions

Link to this function

content_orders_acknowledge(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Marks an order as acknowledged.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersAcknowledgeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_advancetestorder(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

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.
  • order_id (type: String.t) - The ID of the test order to modify.
  • 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.OrdersAdvanceTestOrderResponse{}} on success
  • {:error, info} on failure
Link to this function

content_orders_cancel(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Cancels all line items in an order, making a full refund.

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.
  • order_id (type: String.t) - The ID of the order to cancel.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCancelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_cancellineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Cancels a line item, making a full refund.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCancelLineItemRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_canceltestorderbycustomer(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Sandbox only. Cancels a test order for customer-initiated cancellation.

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.
  • order_id (type: String.t) - The ID of the test order to cancel.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCancelTestOrderByCustomerRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Sandbox only. Creates a test order.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that should manage 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCreateTestOrderRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_createtestreturn(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Sandbox only. Creates a test return.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCreateTestReturnRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_custombatch(connection, optional_params \\ [], opts \\ [])

View Source

Specs

content_orders_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V2.Model.OrdersCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves or modifies multiple orders in a single request.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_get(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieves an order 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.
  • order_id (type: String.t) - The ID of the order.
  • 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.Order{}} on success
  • {:error, info} on failure
Link to this function

content_orders_getbymerchantorderid(connection, merchant_id, merchant_order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieves an order using merchant order ID.

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.
  • merchant_order_id (type: String.t) - The merchant order ID to be looked for.
  • 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.OrdersGetByMerchantOrderIdResponse{}} on success
  • {:error, info} on failure
Link to this function

content_orders_gettestordertemplate(connection, merchant_id, template_name, optional_params \\ [], opts \\ [])

View Source

Specs

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

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that should manage the order. This cannot be a multi-client account.
  • template_name (type: String.t) - The name of the template to retrieve.
  • 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").
    • :country (type: String.t) - The country of the template to retrieve. Defaults to US.
  • opts (type: keyword()) - Call options

Returns

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

content_orders_instorerefundlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersInStoreRefundLineItemRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Lists the orders 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").
    • :acknowledged (type: boolean()) - Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
    • :maxResults (type: integer()) - The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
    • :orderBy (type: String.t) - Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc
    • :pageToken (type: String.t) - The token returned by the previous request.
    • :placedDateEnd (type: String.t) - Obtains orders placed before this date (exclusively), in ISO 8601 format.
    • :placedDateStart (type: String.t) - Obtains orders placed after this date (inclusively), in ISO 8601 format.
    • :statuses (type: list(String.t)) - Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.
  • opts (type: keyword()) - Call options

Returns

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

content_orders_refund(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deprecated, please use returnRefundLineItem instead.

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.
  • order_id (type: String.t) - The ID of the order to refund.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersRefundRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_rejectreturnlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Rejects return on an line item.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersRejectReturnLineItemRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_returnlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Returns a line item.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersReturnLineItemRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_returnrefundlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersReturnRefundLineItemRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_setlineitemmetadata(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersSetLineItemMetadataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_shiplineitems(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Marks line item(s) as shipped.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersShipLineItemsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_updatelineitemshippingdetails(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Updates ship by and delivery by dates for a line item.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersUpdateLineItemShippingDetailsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_updatemerchantorderid(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Updates the merchant order ID for a given order.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersUpdateMerchantOrderIdRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

content_orders_updateshipment(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Updates a shipment's status, carrier, and/or tracking ID.

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.
  • order_id (type: String.t) - The ID of the order.
  • 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").
    • :body (type: GoogleApi.Content.V2.Model.OrdersUpdateShipmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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