blob: 95be1c959045a03e04bec0d056103e8d9d997182 [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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800116 &quot;entries&quot;: [ # The request entries to be processed in the batch.
117 {
118 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
119 &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`.
120 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
121 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
122 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
123 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventory`&quot;
124 &quot;price&quot;: { # Required. The current price of the item.
125 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
126 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800127 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
129 &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.
130 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
131 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
134 &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;
135 &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`.
136 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
137 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
138 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
139 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
140 &quot;price&quot;: { # Required. The price of the item.
141 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
142 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
143 },
144 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
145 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
146 &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.
147 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
148 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
149 },
150 &quot;store&quot;: { # Store resource. # The store information to submit. This should be set only if the method is `insert`.
151 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
152 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
153 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
154 },
155 &quot;storeCode&quot;: &quot;A String&quot;, # The store code. This should be set only if the method is `delete` or `get`.
156 &quot;targetMerchantId&quot;: &quot;A String&quot;, # The ID of the account for which to get/submit data.
157 },
158 ],
159}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160
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 Botcc94ec82021-01-15 07:10:04 -0800171 &quot;entries&quot;: [ # The result of the execution of the batch requests.
172 {
173 &quot;batchId&quot;: 42, # The ID of the request entry to which this entry responds.
174 &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.
175 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
176 &quot;errors&quot;: [ # A list of errors.
177 { # An error returned by the API.
178 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
179 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
180 &quot;reason&quot;: &quot;A String&quot;, # The error code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800181 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 ],
183 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 &quot;inventory&quot;: { # The absolute quantity of an item available at the given store. # The updated inventory information.
186 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
187 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
188 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
189 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventory`&quot;
190 &quot;price&quot;: { # Required. The current price of the item.
191 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
192 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
193 },
194 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
195 &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.
196 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
197 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
198 },
199 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posCustomBatchResponseEntry`&quot;
200 &quot;sale&quot;: { # The change of the available quantity of an item at the given store. # The updated sale information.
201 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
202 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
203 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
204 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
205 &quot;price&quot;: { # Required. The price of the item.
206 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
207 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
208 },
209 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
210 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
211 &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.
212 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
213 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
214 },
215 &quot;store&quot;: { # Store resource. # The retrieved or updated store information.
216 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
217 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
218 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
219 },
220 },
221 ],
222 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posCustomBatchResponse&quot;.
223}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224</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 Botcc94ec82021-01-15 07:10:04 -0800259 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
260 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
261 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
262}</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;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 -0800277 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800278 &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 -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 Botcc94ec82021-01-15 07:10:04 -0800291 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
292 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
293 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
294}</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 Botcc94ec82021-01-15 07:10:04 -0800308 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
309 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
310 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
311 &quot;price&quot;: { # Required. The current price of the item.
312 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
313 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
314 },
315 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
316 &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.
317 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
318 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
319}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320
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 Botcc94ec82021-01-15 07:10:04 -0800331 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
332 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
333 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
334 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posInventoryResponse&quot;.
335 &quot;price&quot;: { # Required. The current price of the item.
336 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
337 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
338 },
339 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
340 &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.
341 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
342 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
343}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700344</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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800362 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posListResponse&quot;.
363 &quot;resources&quot;: [
364 { # Store resource.
365 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
366 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
367 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
368 },
369 ],
370}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371</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 Botcc94ec82021-01-15 07:10:04 -0800384 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
385 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
386 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
387 &quot;price&quot;: { # Required. The price of the item.
388 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
389 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
390 },
391 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
392 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
393 &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.
394 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
395 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
396}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700397
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 Botcc94ec82021-01-15 07:10:04 -0800408 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
409 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
410 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
411 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#posSaleResponse&quot;.
412 &quot;price&quot;: { # Required. The price of the item.
413 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
414 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
415 },
416 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
417 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
418 &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.
419 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
420 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
421}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422</div>
423
424</body></html>