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
|
<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="#custombatch">custombatch(body, dryRun=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)</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)</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, dryRun=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, dryRun=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)</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, dryRun=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="custombatch">custombatch(body, dryRun=None)</code>
<pre>Batches multiple POS-related calls in a single request.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{
"storeCode": "A String", # The store code. Set this only if the method is delete or get.
"targetMerchantId": "A String", # The ID of the account for which to get/submit data.
"sale": { # The change of the available quantity of an item at the given store. # The sale information to submit. Set this only if the method is sale.
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "content#posSale".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"saleId": "A String", # A unique ID to group items from the same sale event.
"quantity": "A String", # The relative change of the available quantity. Negative for items returned.
},
"merchantId": "A String", # The ID of the POS data provider.
"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. Set this only if the method is inventory.
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "content#posInventory".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"quantity": "A String", # The available quantity of the item.
},
"method": "A String",
"store": { # Store resource. # The store information to submit. Set this only if the method is insert.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given 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).
Returns:
An object of the form:
{
"kind": "content#posCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".
"entries": [ # The result of the execution of the batch requests.
{
"kind": "content#posCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry".
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
"message": "A String", # The message of the first error in errors.
"code": 42, # The HTTP status of the first error in errors.
"errors": [ # A list of errors.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
},
"sale": { # The change of the available quantity of an item at the given store. # The updated sale information.
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posSale", # Identifies what kind of resource this is. Value: the fixed string "content#posSale".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"saleId": "A String", # A unique ID to group items from the same sale event.
"quantity": "A String", # The relative change of the available quantity. Negative for items returned.
},
"batchId": 42, # The ID of the request entry to which this entry responds.
"inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information.
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "content#posInventory".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"quantity": "A String", # The available quantity of the item.
},
"store": { # Store resource. # The retrieved or updated store information.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given merchant.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, dryRun=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).
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, targetMerchantId, storeCode)</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)
Returns:
An object of the form:
{ # Store resource.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given merchant.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, targetMerchantId, body, dryRun=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. (required)
The object takes the form of:
{ # Store resource.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given 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).
Returns:
An object of the form:
{ # Store resource.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given merchant.
}</pre>
</div>
<div class="method">
<code class="details" id="inventory">inventory(merchantId, targetMerchantId, body, dryRun=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. (required)
The object takes the form of:
{
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # 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", # The CLDR territory code for the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"gtin": "A String", # Global Trade Item Number.
"quantity": "A String", # The available quantity of the item.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Returns:
An object of the form:
{
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posInventoryResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"quantity": "A String", # The available quantity of the item.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, targetMerchantId)</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)
Returns:
An object of the form:
{
"kind": "content#posListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
"resources": [
{ # Store resource.
"storeAddress": "A String", # The street address of the store.
"kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "content#posStore".
"storeCode": "A String", # A store identifier that is unique for the given merchant.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="sale">sale(merchantId, targetMerchantId, body, dryRun=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. (required)
The object takes the form of:
{
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # 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", # The CLDR territory code for the item.
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"saleId": "A String", # A unique ID to group items from the same sale event.
"gtin": "A String", # Global Trade Item Number.
"quantity": "A String", # The relative change of the available quantity. Negative for items returned.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Returns:
An object of the form:
{
"itemId": "A String", # A unique identifier for the item.
"storeCode": "A String", # The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
"kind": "content#posSaleResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
"contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
"timestamp": "A String", # The inventory timestamp, in ISO 8601 format.
"price": { # The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"targetCountry": "A String", # The CLDR territory code for the item.
"gtin": "A String", # Global Trade Item Number.
"saleId": "A String", # A unique ID to group items from the same sale event.
"quantity": "A String", # The relative change of the available quantity. Negative for items returned.
}</pre>
</div>
</body></html>
|
