GoogleApi.Content.V2.Api.Pos (google_api_content v0.41.1) View Source
API calls for all endpoints tagged Pos
.
Link to this section Summary
Functions
Batches multiple POS-related calls in a single request.
Deletes a store for the given merchant.
Retrieves information about the given store.
Creates a store for the given merchant.
Submit inventory for the given merchant.
Lists the stores of the target merchant.
Submit a sale event for the given merchant.
Link to this section Functions
Link to this function
content_pos_custombatch(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_custombatch(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Content.V2.Model.PosCustomBatchResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Batches multiple POS-related calls in a single request.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
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. -
:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). -
:body
(type:GoogleApi.Content.V2.Model.PosCustomBatchRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V2.Model.PosCustomBatchResponse{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_delete(connection, merchant_id, target_merchant_id, store_code, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a store for the given merchant.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
store_code
(type:String.t
) - A store code that is unique per merchant. -
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. -
:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_get(connection, merchant_id, target_merchant_id, store_code, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.PosStore.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves information about the given store.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
store_code
(type:String.t
) - A store code that is unique per merchant. -
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.V2.Model.PosStore{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_insert(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_insert( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.PosStore.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a store for the given merchant.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
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. -
:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). -
:body
(type:GoogleApi.Content.V2.Model.PosStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V2.Model.PosStore{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_inventory(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_inventory( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.PosInventoryResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Submit inventory for the given merchant.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
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. -
:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). -
:body
(type:GoogleApi.Content.V2.Model.PosInventoryRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V2.Model.PosInventoryResponse{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_list(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.PosListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the stores of the target merchant.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
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.V2.Model.PosListResponse{}}
on success -
{:error, info}
on failure
Link to this function
content_pos_sale(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ [])
View SourceSpecs
content_pos_sale( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V2.Model.PosSaleResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Submit a sale event for the given merchant.
Parameters
-
connection
(type:GoogleApi.Content.V2.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - The ID of the POS or inventory data provider. -
target_merchant_id
(type:String.t
) - The ID of the target merchant. -
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. -
:dryRun
(type:boolean()
) - Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). -
:body
(type:GoogleApi.Content.V2.Model.PosSaleRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V2.Model.PosSaleResponse{}}
on success -
{:error, info}
on failure