google_api_content v0.31.0 GoogleApi.Content.V21.Api.Orders View Source
API calls for all endpoints tagged Orders
.
Link to this section Summary
Functions
Marks an order as acknowledged.
Sandbox only. Moves a test order from state "inProgress
" to state "pendingShipment
".
Cancels all line items in an order, making a full refund.
Cancels a line item, making a full refund.
Sandbox only. Cancels a test order for customer-initiated cancellation.
Sandbox only. Creates a test order.
Sandbox only. Creates a test return.
Retrieves an order from your Merchant Center account.
Retrieves an order using merchant order ID.
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.
Lists the orders in your Merchant Center account.
Rejects return on an line item.
Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
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.
Marks line item(s) as shipped.
Updates ship by and delivery by dates for a line item.
Updates the merchant order ID for a given order.
Updates a shipment's status, carrier, and/or tracking ID.
Link to this section Functions
content_orders_acknowledge(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_acknowledge( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersAcknowledgeResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Marks an order as acknowledged.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersAcknowledgeRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersAcknowledgeResponse{}}
on success{:error, info}
on failure
content_orders_advancetestorder(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_advancetestorder( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.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 test order to modify.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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersAdvanceTestOrderResponse{}}
on success{:error, info}
on failure
content_orders_cancel(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_cancel( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.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 to cancel.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.V21.Model.OrdersCancelRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersCancelResponse{}}
on success{:error, info}
on failure
content_orders_cancellineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_cancellineitem( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersCancelLineItemResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Cancels a line item, making a full refund.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersCancelLineItemRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersCancelLineItemResponse{}}
on success{:error, info}
on failure
content_orders_canceltestorderbycustomer(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_canceltestorderbycustomer( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersCancelTestOrderByCustomerResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sandbox only. Cancels a test order for customer-initiated cancellation.
Parameters
connection
(type:GoogleApi.Content.V21.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 test order to cancel.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.V21.Model.OrdersCancelTestOrderByCustomerRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersCancelTestOrderByCustomerResponse{}}
on success{:error, info}
on failure
content_orders_createtestorder(connection, merchant_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_createtestorder( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersCreateTestOrderResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sandbox only. Creates a test order.
Parameters
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to servermerchant_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: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.V21.Model.OrdersCreateTestOrderRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersCreateTestOrderResponse{}}
on success{:error, info}
on failure
content_orders_createtestreturn(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_createtestreturn( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersCreateTestReturnResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sandbox only. Creates a test return.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersCreateTestReturnRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersCreateTestReturnResponse{}}
on success{:error, info}
on failure
content_orders_get(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.Order.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves an order from your Merchant Center account.
Parameters
connection
(type:GoogleApi.Content.V21.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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.Order{}}
on success{:error, info}
on failure
content_orders_getbymerchantorderid(connection, merchant_id, merchant_order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_getbymerchantorderid( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersGetByMerchantOrderIdResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves an order using merchant order ID.
Parameters
connection
(type:GoogleApi.Content.V21.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.merchant_order_id
(type:String.t
) - The merchant order ID to be looked for.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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersGetByMerchantOrderIdResponse{}}
on success{:error, info}
on failure
content_orders_gettestordertemplate(connection, merchant_id, template_name, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_gettestordertemplate( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.Connection.t
) - Connection to servermerchant_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: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.:country
(type:String.t
) - The country of the template to retrieve. Defaults toUS
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersGetTestOrderTemplateResponse{}}
on success{:error, info}
on failure
content_orders_instorerefundlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_instorerefundlineitem( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.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.V21.Model.OrdersInStoreRefundLineItemRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersInStoreRefundLineItemResponse{}}
on success{:error, info}
on failure
content_orders_list(connection, merchant_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V21.Model.OrdersListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the orders in your Merchant Center account.
Parameters
connection
(type:GoogleApi.Content.V21.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.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.: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 tofalse
, in conjunction with theacknowledge
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 thatactive
is a shortcut forpendingShipment
andpartiallyShipped
, andcompleted
is a shortcut forshipped
,partiallyDelivered
,delivered
,partiallyReturned
,returned
, andcanceled
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersListResponse{}}
on success{:error, info}
on failure
content_orders_rejectreturnlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_rejectreturnlineitem( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersRejectReturnLineItemResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Rejects return on an line item.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersRejectReturnLineItemRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersRejectReturnLineItemResponse{}}
on success{:error, info}
on failure
content_orders_returnrefundlineitem(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_returnrefundlineitem( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersReturnRefundLineItemRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersReturnRefundLineItemResponse{}}
on success{:error, info}
on failure
content_orders_setlineitemmetadata(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_setlineitemmetadata( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.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.V21.Model.OrdersSetLineItemMetadataRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersSetLineItemMetadataResponse{}}
on success{:error, info}
on failure
content_orders_shiplineitems(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_shiplineitems( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersShipLineItemsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Marks line item(s) as shipped.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersShipLineItemsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersShipLineItemsResponse{}}
on success{:error, info}
on failure
content_orders_updatelineitemshippingdetails(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_updatelineitemshippingdetails( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.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.V21.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.V21.Model.OrdersUpdateLineItemShippingDetailsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersUpdateLineItemShippingDetailsResponse{}}
on success{:error, info}
on failure
content_orders_updatemerchantorderid(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_updatemerchantorderid( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersUpdateMerchantOrderIdResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the merchant order ID for a given order.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersUpdateMerchantOrderIdRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersUpdateMerchantOrderIdResponse{}}
on success{:error, info}
on failure
content_orders_updateshipment(connection, merchant_id, order_id, optional_params \\ [], opts \\ [])
View Sourcecontent_orders_updateshipment( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.OrdersUpdateShipmentResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a shipment's status, carrier, and/or tracking ID.
Parameters
connection
(type:GoogleApi.Content.V21.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.V21.Model.OrdersUpdateShipmentRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Content.V21.Model.OrdersUpdateShipmentResponse{}}
on success{:error, info}
on failure