blob: 165f4e532abb3988d4e5f09806c1612bab4e957c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.pos.html">pos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070081 <code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Batches multiple POS-related calls in a single request.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070084 <code><a href="#delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Deletes a store for the given merchant.</p>
86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070087 <code><a href="#get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Retrieves information about the given store.</p>
89<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070090 <code><a href="#insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Creates a store for the given merchant.</p>
92<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070093 <code><a href="#inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Submit inventory for the given merchant.</p>
95<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070096 <code><a href="#list">list(merchantId, targetMerchantId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Lists the stores of the target merchant.</p>
98<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070099 <code><a href="#sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Submit a sale event for the given merchant.</p>
101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700108 <code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 <pre>Batches multiple POS-related calls in a single request.
110
111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700112 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 The object takes the form of:
114
115{
Bu Sun Kim65020912020-05-20 12:08:20 -0700116 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800118 &quot;targetMerchantId&quot;: &quot;A String&quot;, # The ID of the account for which to get/submit data.
119 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry. Acceptable values are: - &quot;`delete`&quot; - &quot;`get`&quot; - &quot;`insert`&quot; - &quot;`inventory`&quot; - &quot;`sale`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800120 &quot;inventory&quot;: { # The absolute quantity of an item available at the given store. # The inventory to submit. This should be set only if the method is `inventory`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800121 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
122 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
123 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
124 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
125 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventory`&quot;
126 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800127 &quot;price&quot;: { # Required. The current price of the item.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800128 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800129 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800130 },
131 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800132 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800133 },
134 &quot;sale&quot;: { # The change of the available quantity of an item at the given store. # The sale information to submit. This should be set only if the method is `sale`.
135 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
136 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800137 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800139 &quot;price&quot;: { # Required. The price of the item.
140 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
141 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
142 },
143 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
144 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
145 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
146 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
147 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800149 &quot;storeCode&quot;: &quot;A String&quot;, # The store code. This should be set only if the method is `delete` or `get`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800150 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800151 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800152 &quot;store&quot;: { # Store resource. # The store information to submit. This should be set only if the method is `insert`.
153 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800154 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800155 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800156 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157 },
158 ],
159 }
160
161 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700166
167Returns:
168 An object of the form:
169
170 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800171 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posCustomBatchResponse&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700172 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800174 &quot;batchId&quot;: 42, # The ID of the request entry to which this entry responds.
175 &quot;inventory&quot;: { # The absolute quantity of an item available at the given store. # The updated inventory information.
176 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
177 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
178 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
179 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
180 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventory`&quot;
181 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
182 &quot;price&quot;: { # Required. The current price of the item.
183 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
184 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
185 },
186 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
187 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
188 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800189 &quot;store&quot;: { # Store resource. # The retrieved or updated store information.
190 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800191 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800192 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700193 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800194 &quot;sale&quot;: { # The change of the available quantity of an item at the given store. # The updated sale information.
195 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
196 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
197 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
198 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
199 &quot;price&quot;: { # Required. The price of the item.
200 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
201 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
202 },
203 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
204 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
205 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
206 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
207 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
208 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800211 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800212 &quot;errors&quot;: [ # A list of errors.
213 { # An error returned by the API.
214 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
215 &quot;reason&quot;: &quot;A String&quot;, # The error code.
216 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
217 },
218 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800219 },
220 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posCustomBatchResponseEntry`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700221 },
222 ],
223 }</pre>
224</div>
225
226<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700227 <code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 <pre>Deletes a store for the given merchant.
229
230Args:
231 merchantId: string, The ID of the POS or inventory data provider. (required)
232 targetMerchantId: string, The ID of the target merchant. (required)
233 storeCode: string, A store code that is unique per merchant. (required)
234 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239</pre>
240</div>
241
242<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700243 <code class="details" id="get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700244 <pre>Retrieves information about the given store.
245
246Args:
247 merchantId: string, The ID of the POS or inventory data provider. (required)
248 targetMerchantId: string, The ID of the target merchant. (required)
249 storeCode: string, A store code that is unique per merchant. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700250 x__xgafv: string, V1 error format.
251 Allowed values
252 1 - v1 error format
253 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254
255Returns:
256 An object of the form:
257
258 { # Store resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800259 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800260 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800261 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800262 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263</div>
264
265<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700266 <code class="details" id="insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700267 <pre>Creates a store for the given merchant.
268
269Args:
270 merchantId: string, The ID of the POS or inventory data provider. (required)
271 targetMerchantId: string, The ID of the target merchant. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700272 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700273 The object takes the form of:
274
275{ # Store resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800276 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800277 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800278 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800279}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280
281 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286
287Returns:
288 An object of the form:
289
290 { # Store resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800291 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800292 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800293 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800294 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295</div>
296
297<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700298 <code class="details" id="inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 <pre>Submit inventory for the given merchant.
300
301Args:
302 merchantId: string, The ID of the POS or inventory data provider. (required)
303 targetMerchantId: string, The ID of the target merchant. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700304 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305 The object takes the form of:
306
307{
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800308 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800309 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800310 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800311 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
312 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800313 &quot;price&quot;: { # Required. The current price of the item.
314 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
315 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
316 },
317 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
318 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700319 }
320
321 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700322 x__xgafv: string, V1 error format.
323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326
327Returns:
328 An object of the form:
329
330 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800331 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800332 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posInventoryResponse&quot;.
333 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800334 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800335 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800336 &quot;price&quot;: { # Required. The current price of the item.
337 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
338 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
339 },
340 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
341 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
342 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343 }</pre>
344</div>
345
346<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700347 <code class="details" id="list">list(merchantId, targetMerchantId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700348 <pre>Lists the stores of the target merchant.
349
350Args:
351 merchantId: string, The ID of the POS or inventory data provider. (required)
352 targetMerchantId: string, The ID of the target merchant. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700353 x__xgafv: string, V1 error format.
354 Allowed values
355 1 - v1 error format
356 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700357
358Returns:
359 An object of the form:
360
361 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700362 &quot;resources&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 { # Store resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800364 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800365 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800366 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800367 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700368 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800369 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posListResponse&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 }</pre>
371</div>
372
373<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700374 <code class="details" id="sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 <pre>Submit a sale event for the given merchant.
376
377Args:
378 merchantId: string, The ID of the POS or inventory data provider. (required)
379 targetMerchantId: string, The ID of the target merchant. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700380 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700381 The object takes the form of:
382
383{
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800384 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800385 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800386 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
387 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
388 &quot;price&quot;: { # Required. The price of the item.
389 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
390 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
391 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800392 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800393 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
394 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
395 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700396 }
397
398 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700399 x__xgafv: string, V1 error format.
400 Allowed values
401 1 - v1 error format
402 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700403
404Returns:
405 An object of the form:
406
407 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800408 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posSaleResponse&quot;.
409 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800410 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
411 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800412 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800413 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
414 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
415 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
416 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
417 &quot;price&quot;: { # Required. The price of the item.
418 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
419 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
420 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700421 }</pre>
422</div>
423
424</body></html>