Files
google-apis-rs/google_content2_cli/pos_insert/index.html
2024-03-05 21:06:01 +01:00

514 lines
25 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-content2-cli/pos_insert/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Insert - Shopping Content v5.0.4+20220303</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Insert";
var mkdocs_page_input_path = "pos_insert.md";
var mkdocs_page_url = "/google-apis-rs/google-content2-cli/pos_insert/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Shopping Content v5.0.4+20220303
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Accounts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../accounts_authinfo/">Authinfo</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_claimwebsite/">Claimwebsite</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_link/">Link</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounts_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Accountstatuses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../accountstatuses_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accountstatuses_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accountstatuses_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Accounttax</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../accounttax_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounttax_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounttax_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../accounttax_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Datafeeds</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_fetchnow/">Fetchnow</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeeds_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Datafeedstatuses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../datafeedstatuses_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeedstatuses_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../datafeedstatuses_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Inventory</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../inventory_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../inventory_set/">Set</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Liasettings</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_getaccessiblegmbaccounts/">Getaccessiblegmbaccounts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_listposdataproviders/">Listposdataproviders</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_requestgmbaccess/">Requestgmbaccess</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_requestinventoryverification/">Requestinventoryverification</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_setinventoryverificationcontact/">Setinventoryverificationcontact</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_setposdataprovider/">Setposdataprovider</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../liasettings_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Orderinvoices</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orderinvoices_createchargeinvoice/">Createchargeinvoice</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orderinvoices_createrefundinvoice/">Createrefundinvoice</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Orderreports</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orderreports_listdisbursements/">Listdisbursements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orderreports_listtransactions/">Listtransactions</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Orderreturns</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orderreturns_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orderreturns_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Orders</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orders_acknowledge/">Acknowledge</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_advancetestorder/">Advancetestorder</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_cancel/">Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_cancellineitem/">Cancellineitem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_canceltestorderbycustomer/">Canceltestorderbycustomer</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_createtestorder/">Createtestorder</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_createtestreturn/">Createtestreturn</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_getbymerchantorderid/">Getbymerchantorderid</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_gettestordertemplate/">Gettestordertemplate</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_instorerefundlineitem/">Instorerefundlineitem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_refund/">Refund</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_rejectreturnlineitem/">Rejectreturnlineitem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_returnlineitem/">Returnlineitem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_returnrefundlineitem/">Returnrefundlineitem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_setlineitemmetadata/">Setlineitemmetadata</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_shiplineitems/">Shiplineitems</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_updatelineitemshippingdetails/">Updatelineitemshippingdetails</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_updatemerchantorderid/">Updatemerchantorderid</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orders_updateshipment/">Updateshipment</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Pos</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../pos_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pos_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pos_get/">Get</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Insert</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pos_inventory/">Inventory</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pos_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pos_sale/">Sale</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Products</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../products_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../products_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../products_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../products_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../products_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Productstatuses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../productstatuses_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../productstatuses_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../productstatuses_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Shippingsettings</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_custombatch/">Custombatch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_getsupportedcarriers/">Getsupportedcarriers</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_getsupportedholidays/">Getsupportedholidays</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_getsupportedpickupservices/">Getsupportedpickupservices</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../shippingsettings_update/">Update</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Shopping Content v5.0.4+20220303</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Pos &raquo;</li>
<li>Insert</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/content2-cli/edit/master/docs/pos_insert.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Creates a store for the given merchant.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/content</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/content</em>.
You can set the scope for this method like this: <code>content2 --scope &lt;scope&gt; pos insert ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;merchant-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the POS or inventory data provider.</li>
</ul>
</li>
<li><strong>&lt;target-merchant-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the target merchant.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>PosStore:
gcid-category: [string]
kind: string
phone-number: string
place-id: string
store-address: string
store-code: string
store-name: string
website-url: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . gcid-category=stet</code><ul>
<li>The business type of the store.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>kind=aliquyam</code><ul>
<li>Identifies what kind of resource this is. Value: the fixed string &#34;<code>content#posStore</code>&#34;</li>
</ul>
</li>
<li><code>phone-number=ut</code><ul>
<li>The store phone number.</li>
</ul>
</li>
<li><code>place-id=sit</code><ul>
<li>The Google Place Id of the store location.</li>
</ul>
</li>
<li><code>store-address=vero</code><ul>
<li>Required. The street address of the store.</li>
</ul>
</li>
<li><code>store-code=rebum.</code><ul>
<li>Required. A store identifier that is unique for the given merchant.</li>
</ul>
</li>
<li><code>store-name=dolores</code><ul>
<li>The merchant or store name.</li>
</ul>
</li>
<li><code>website-url=consetetur</code><ul>
<li>The website url for the store or merchant.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li><strong>-p dry-run=boolean</strong><ul>
<li>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).</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../pos_get/" class="btn btn-neutral float-left" title="Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../pos_inventory/" class="btn btn-neutral float-right" title="Inventory">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/content2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../pos_get/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../pos_inventory/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>