google_api_content v0.9.0 GoogleApi.Content.V2.Api.Pos 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
content_pos_custombatch(connection, optional_params \\ [], opts \\ []) View Source
Batches multiple POS-related calls in a single request.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (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 (PosCustomBatchRequest):
Returns
{:ok, %GoogleApi.Content.V2.Model.PosCustomBatchResponse{}} on success {:error, info} on failure
content_pos_delete(connection, merchant_id, target_merchant_id, store_code, optional_params \\ [], opts \\ []) View Source
Deletes a store for the given merchant.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
- store_code (String.t): A store code that is unique per merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (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).
Returns
{:ok, %{}} on success {:error, info} on failure
content_pos_get(connection, merchant_id, target_merchant_id, store_code, optional_params \\ [], opts \\ []) View Source
Retrieves information about the given store.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
- store_code (String.t): A store code that is unique per merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Content.V2.Model.PosStore{}} on success {:error, info} on failure
content_pos_insert(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ []) View Source
Creates a store for the given merchant.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (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 (PosStore):
Returns
{:ok, %GoogleApi.Content.V2.Model.PosStore{}} on success {:error, info} on failure
content_pos_inventory(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ []) View Source
Submit inventory for the given merchant.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (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 (PosInventoryRequest):
Returns
{:ok, %GoogleApi.Content.V2.Model.PosInventoryResponse{}} on success {:error, info} on failure
content_pos_list(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ []) View Source
Lists the stores of the target merchant.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Content.V2.Model.PosListResponse{}} on success {:error, info} on failure
content_pos_sale(connection, merchant_id, target_merchant_id, optional_params \\ [], opts \\ []) View Source
Submit a sale event for the given merchant.
Parameters
- connection (GoogleApi.Content.V2.Connection): Connection to server
- merchant_id (String.t): The ID of the POS or inventory data provider.
- target_merchant_id (String.t): The ID of the target merchant.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dryRun (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 (PosSaleRequest):
Returns
{:ok, %GoogleApi.Content.V2.Model.PosSaleResponse{}} on success {:error, info} on failure