1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.pos.html">pos</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batches multiple POS-related calls in a single request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a store for the given merchant.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves information about the given store.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a store for the given merchant.</p>
<p class="toc_element">
<code><a href="#inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submit inventory for the given merchant.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, targetMerchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the stores of the target merchant.</p>
<p class="toc_element">
<code><a href="#sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submit a sale event for the given merchant.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code>
<pre>Batches multiple POS-related calls in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{
"batchId": 42, # An entry ID, unique within the batch request.
"inventory": { # 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`.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"merchantId": "A String", # The ID of the POS data provider.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`"
"sale": { # 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`.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"store": { # Store resource. # The store information to submit. This should be set only if the method is `insert`.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
"storeCode": "A String", # The store code. This should be set only if the method is `delete` or `get`.
"targetMerchantId": "A String", # The ID of the account for which to get/submit data.
},
],
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{
"batchId": 42, # The ID of the request entry to which this entry responds.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`"
"sale": { # The change of the available quantity of an item at the given store. # The updated sale information.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"store": { # Store resource. # The retrieved or updated store information.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</code>
<pre>Deletes a store for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
storeCode: string, A store code that is unique per merchant. (required)
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code>
<pre>Retrieves information about the given store.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
storeCode: string, A store code that is unique per merchant. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Creates a store for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}</pre>
</div>
<div class="method">
<code class="details" id="inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Submit inventory for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, targetMerchantId, x__xgafv=None)</code>
<pre>Lists the stores of the target merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
"resources": [
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Submit a sale event for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}</pre>
</div>
</body></html>
|
