1<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_1.html">Content API for Shopping</a> . <a href="content_v2_1.pos.html">pos</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Batches multiple POS-related calls in a single request.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(merchantId, targetMerchantId, storeCode, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a store for the given merchant.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves information about the given store.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(merchantId, targetMerchantId, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Creates a store for the given merchant.</p> 92<p class="toc_element"> 93 <code><a href="#inventory">inventory(merchantId, targetMerchantId, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Submit inventory for the given merchant.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(merchantId, targetMerchantId, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists the stores of the target merchant.</p> 98<p class="toc_element"> 99 <code><a href="#sale">sale(merchantId, targetMerchantId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Submit a sale event for the given merchant.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code> 109 <pre>Batches multiple POS-related calls in a single request. 110 111Args: 112 body: object, The request body. 113 The object takes the form of: 114 115{ 116 "entries": [ # The request entries to be processed in the batch. 117 { 118 "batchId": 42, # An entry ID, unique within the batch request. 119 "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`. 120 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 121 "gtin": "A String", # Global Trade Item Number. 122 "itemId": "A String", # Required. A unique identifier for the item. 123 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" 124 "price": { # Required. The current price of the item. 125 "currency": "A String", # The currency of the price. 126 "value": "A String", # The price represented as a number. 127 }, 128 "quantity": "A String", # Required. The available quantity of the item. 129 "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 a Business Profile. 130 "targetCountry": "A String", # Required. The CLDR territory code for the item. 131 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 132 }, 133 "merchantId": "A String", # The ID of the POS data provider. 134 "method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`" 135 "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`. 136 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 137 "gtin": "A String", # Global Trade Item Number. 138 "itemId": "A String", # Required. A unique identifier for the item. 139 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" 140 "price": { # Required. The price of the item. 141 "currency": "A String", # The currency of the price. 142 "value": "A String", # The price represented as a number. 143 }, 144 "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. 145 "saleId": "A String", # A unique ID to group items from the same sale event. 146 "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 a Business Profile. 147 "targetCountry": "A String", # Required. The CLDR territory code for the item. 148 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 149 }, 150 "store": { # Store resource. # The store information to submit. This should be set only if the method is `insert`. 151 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 152 "storeAddress": "A String", # Required. The street address of the store. 153 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 154 }, 155 "storeCode": "A String", # The store code. This should be set only if the method is `delete` or `get`. 156 "targetMerchantId": "A String", # The ID of the account for which to get/submit data. 157 }, 158 ], 159} 160 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { 170 "entries": [ # The result of the execution of the batch requests. 171 { 172 "batchId": 42, # The ID of the request entry to which this entry responds. 173 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed. 174 "code": 42, # The HTTP status of the first error in `errors`. 175 "errors": [ # A list of errors. 176 { # An error returned by the API. 177 "domain": "A String", # The domain of the error. 178 "message": "A String", # A description of the error. 179 "reason": "A String", # The error code. 180 }, 181 ], 182 "message": "A String", # The message of the first error in `errors`. 183 }, 184 "inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information. 185 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 186 "gtin": "A String", # Global Trade Item Number. 187 "itemId": "A String", # Required. A unique identifier for the item. 188 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" 189 "price": { # Required. The current price of the item. 190 "currency": "A String", # The currency of the price. 191 "value": "A String", # The price represented as a number. 192 }, 193 "quantity": "A String", # Required. The available quantity of the item. 194 "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 a Business Profile. 195 "targetCountry": "A String", # Required. The CLDR territory code for the item. 196 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 197 }, 198 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`" 199 "sale": { # The change of the available quantity of an item at the given store. # The updated sale information. 200 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 201 "gtin": "A String", # Global Trade Item Number. 202 "itemId": "A String", # Required. A unique identifier for the item. 203 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" 204 "price": { # Required. The price of the item. 205 "currency": "A String", # The currency of the price. 206 "value": "A String", # The price represented as a number. 207 }, 208 "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. 209 "saleId": "A String", # A unique ID to group items from the same sale event. 210 "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 a Business Profile. 211 "targetCountry": "A String", # Required. The CLDR territory code for the item. 212 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 213 }, 214 "store": { # Store resource. # The retrieved or updated store information. 215 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 216 "storeAddress": "A String", # Required. The street address of the store. 217 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 218 }, 219 }, 220 ], 221 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponse`". 222}</pre> 223</div> 224 225<div class="method"> 226 <code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code> 227 <pre>Deletes a store for the given merchant. 228 229Args: 230 merchantId: string, The ID of the POS or inventory data provider. (required) 231 targetMerchantId: string, The ID of the target merchant. (required) 232 storeCode: string, A store code that is unique per merchant. (required) 233 x__xgafv: string, V1 error format. 234 Allowed values 235 1 - v1 error format 236 2 - v2 error format 237</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code> 242 <pre>Retrieves information about the given store. 243 244Args: 245 merchantId: string, The ID of the POS or inventory data provider. (required) 246 targetMerchantId: string, The ID of the target merchant. (required) 247 storeCode: string, A store code that is unique per merchant. (required) 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Store resource. 257 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 258 "storeAddress": "A String", # Required. The street address of the store. 259 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 260}</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="insert">insert(merchantId, targetMerchantId, body=None, x__xgafv=None)</code> 265 <pre>Creates a store for the given merchant. 266 267Args: 268 merchantId: string, The ID of the POS or inventory data provider. (required) 269 targetMerchantId: string, The ID of the target merchant. (required) 270 body: object, The request body. 271 The object takes the form of: 272 273{ # Store resource. 274 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 275 "storeAddress": "A String", # Required. The street address of the store. 276 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 277} 278 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # Store resource. 288 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 289 "storeAddress": "A String", # Required. The street address of the store. 290 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 291}</pre> 292</div> 293 294<div class="method"> 295 <code class="details" id="inventory">inventory(merchantId, targetMerchantId, body=None, x__xgafv=None)</code> 296 <pre>Submit inventory for the given merchant. 297 298Args: 299 merchantId: string, The ID of the POS or inventory data provider. (required) 300 targetMerchantId: string, The ID of the target merchant. (required) 301 body: object, The request body. 302 The object takes the form of: 303 304{ 305 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 306 "gtin": "A String", # Global Trade Item Number. 307 "itemId": "A String", # Required. A unique identifier for the item. 308 "price": { # Required. The current price of the item. 309 "currency": "A String", # The currency of the price. 310 "value": "A String", # The price represented as a number. 311 }, 312 "quantity": "A String", # Required. The available quantity of the item. 313 "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 a Business Profile. 314 "targetCountry": "A String", # Required. The CLDR territory code for the item. 315 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 316} 317 318 x__xgafv: string, V1 error format. 319 Allowed values 320 1 - v1 error format 321 2 - v2 error format 322 323Returns: 324 An object of the form: 325 326 { 327 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 328 "gtin": "A String", # Global Trade Item Number. 329 "itemId": "A String", # Required. A unique identifier for the item. 330 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventoryResponse`". 331 "price": { # Required. The current price of the item. 332 "currency": "A String", # The currency of the price. 333 "value": "A String", # The price represented as a number. 334 }, 335 "quantity": "A String", # Required. The available quantity of the item. 336 "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 a Business Profile. 337 "targetCountry": "A String", # Required. The CLDR territory code for the item. 338 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 339}</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="list">list(merchantId, targetMerchantId, x__xgafv=None)</code> 344 <pre>Lists the stores of the target merchant. 345 346Args: 347 merchantId: string, The ID of the POS or inventory data provider. (required) 348 targetMerchantId: string, The ID of the target merchant. (required) 349 x__xgafv: string, V1 error format. 350 Allowed values 351 1 - v1 error format 352 2 - v2 error format 353 354Returns: 355 An object of the form: 356 357 { 358 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posListResponse`". 359 "resources": [ 360 { # Store resource. 361 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" 362 "storeAddress": "A String", # Required. The street address of the store. 363 "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. 364 }, 365 ], 366}</pre> 367</div> 368 369<div class="method"> 370 <code class="details" id="sale">sale(merchantId, targetMerchantId, body=None, x__xgafv=None)</code> 371 <pre>Submit a sale event for the given merchant. 372 373Args: 374 merchantId: string, The ID of the POS or inventory data provider. (required) 375 targetMerchantId: string, The ID of the target merchant. (required) 376 body: object, The request body. 377 The object takes the form of: 378 379{ 380 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 381 "gtin": "A String", # Global Trade Item Number. 382 "itemId": "A String", # Required. A unique identifier for the item. 383 "price": { # Required. The price of the item. 384 "currency": "A String", # The currency of the price. 385 "value": "A String", # The price represented as a number. 386 }, 387 "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. 388 "saleId": "A String", # A unique ID to group items from the same sale event. 389 "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 a Business Profile. 390 "targetCountry": "A String", # Required. The CLDR territory code for the item. 391 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 392} 393 394 x__xgafv: string, V1 error format. 395 Allowed values 396 1 - v1 error format 397 2 - v2 error format 398 399Returns: 400 An object of the form: 401 402 { 403 "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. 404 "gtin": "A String", # Global Trade Item Number. 405 "itemId": "A String", # Required. A unique identifier for the item. 406 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSaleResponse`". 407 "price": { # Required. The price of the item. 408 "currency": "A String", # The currency of the price. 409 "value": "A String", # The price represented as a number. 410 }, 411 "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. 412 "saleId": "A String", # A unique ID to group items from the same sale event. 413 "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 a Business Profile. 414 "targetCountry": "A String", # Required. The CLDR territory code for the item. 415 "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. 416}</pre> 417</div> 418 419</body></html>