| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 81 | <code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Batches multiple POS-related calls in a single request.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 84 | <code><a href="#delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes a store for the given merchant.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 87 | <code><a href="#get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Retrieves information about the given store.</p> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 90 | <code><a href="#insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Creates a store for the given merchant.</p> |
| 92 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 93 | <code><a href="#inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Submit inventory for the given merchant.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 96 | <code><a href="#list">list(merchantId, targetMerchantId, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Lists the stores of the target merchant.</p> |
| 98 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 99 | <code><a href="#sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Submit a sale event for the given merchant.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <code class="details" id="close">close()</code> |
| 104 | <pre>Close httplib2 connections.</pre> |
| 105 | </div> |
| 106 | |
| 107 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 108 | <code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <pre>Batches multiple POS-related calls in a single request. |
| 110 | |
| 111 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | The object takes the form of: |
| 114 | |
| 115 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "entries": [ # The request entries to be processed in the batch. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 118 | "targetMerchantId": "A String", # The ID of the account for which to get/submit data. |
| 119 | "method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 120 | "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`. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 121 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| 122 | "itemId": "A String", # Required. A unique identifier for the item. |
| 123 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 124 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 125 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" |
| 126 | "quantity": "A String", # Required. The available quantity of the item. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 127 | "price": { # Required. The current price of the item. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 128 | "currency": "A String", # The currency of the price. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 129 | "value": "A String", # The price represented as a number. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 130 | }, |
| 131 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 132 | "gtin": "A String", # Global Trade Item Number. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 133 | }, |
| 134 | "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`. |
| 135 | "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. |
| 136 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 137 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 139 | "price": { # Required. The price of the item. |
| 140 | "currency": "A String", # The currency of the price. |
| 141 | "value": "A String", # The price represented as a number. |
| 142 | }, |
| 143 | "gtin": "A String", # Global Trade Item Number. |
| 144 | "saleId": "A String", # A unique ID to group items from the same sale event. |
| 145 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 146 | "itemId": "A String", # Required. A unique identifier for the item. |
| 147 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 149 | "storeCode": "A String", # The store code. This should be set only if the method is `delete` or `get`. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 150 | "merchantId": "A String", # The ID of the POS data provider. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 151 | "batchId": 42, # An entry ID, unique within the batch request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 152 | "store": { # Store resource. # The store information to submit. This should be set only if the method is `insert`. |
| 153 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 154 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 155 | "storeAddress": "A String", # Required. The street address of the store. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 156 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 157 | }, |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 162 | x__xgafv: string, V1 error format. |
| 163 | Allowed values |
| 164 | 1 - v1 error format |
| 165 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | |
| 167 | Returns: |
| 168 | An object of the form: |
| 169 | |
| 170 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 171 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "entries": [ # The result of the execution of the batch requests. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 174 | "batchId": 42, # The ID of the request entry to which this entry responds. |
| 175 | "inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information. |
| 176 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| 177 | "itemId": "A String", # Required. A unique identifier for the item. |
| 178 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 179 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 180 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" |
| 181 | "quantity": "A String", # Required. The available quantity of the item. |
| 182 | "price": { # Required. The current price of the item. |
| 183 | "currency": "A String", # The currency of the price. |
| 184 | "value": "A String", # The price represented as a number. |
| 185 | }, |
| 186 | "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. |
| 187 | "gtin": "A String", # Global Trade Item Number. |
| 188 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 189 | "store": { # Store resource. # The retrieved or updated store information. |
| 190 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 191 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 192 | "storeAddress": "A String", # Required. The street address of the store. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 193 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 194 | "sale": { # The change of the available quantity of an item at the given store. # The updated sale information. |
| 195 | "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. |
| 196 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" |
| 197 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| 198 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 199 | "price": { # Required. The price of the item. |
| 200 | "currency": "A String", # The currency of the price. |
| 201 | "value": "A String", # The price represented as a number. |
| 202 | }, |
| 203 | "gtin": "A String", # Global Trade Item Number. |
| 204 | "saleId": "A String", # A unique ID to group items from the same sale event. |
| 205 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 206 | "itemId": "A String", # Required. A unique identifier for the item. |
| 207 | "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. |
| 208 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 209 | "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 210 | "message": "A String", # The message of the first error in `errors`. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 211 | "code": 42, # The HTTP status of the first error in `errors`. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 212 | "errors": [ # A list of errors. |
| 213 | { # An error returned by the API. |
| 214 | "message": "A String", # A description of the error. |
| 215 | "reason": "A String", # The error code. |
| 216 | "domain": "A String", # The domain of the error. |
| 217 | }, |
| 218 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 219 | }, |
| 220 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 221 | }, |
| 222 | ], |
| 223 | }</pre> |
| 224 | </div> |
| 225 | |
| 226 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 227 | <code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, dryRun=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 228 | <pre>Deletes a store for the given merchant. |
| 229 | |
| 230 | Args: |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 235 | x__xgafv: string, V1 error format. |
| 236 | Allowed values |
| 237 | 1 - v1 error format |
| 238 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 239 | </pre> |
| 240 | </div> |
| 241 | |
| 242 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 243 | <code class="details" id="get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 244 | <pre>Retrieves information about the given store. |
| 245 | |
| 246 | Args: |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 250 | x__xgafv: string, V1 error format. |
| 251 | Allowed values |
| 252 | 1 - v1 error format |
| 253 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 254 | |
| 255 | Returns: |
| 256 | An object of the form: |
| 257 | |
| 258 | { # Store resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 259 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 260 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 261 | "storeAddress": "A String", # Required. The street address of the store. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 262 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 263 | </div> |
| 264 | |
| 265 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 266 | <code class="details" id="insert">insert(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 267 | <pre>Creates a store for the given merchant. |
| 268 | |
| 269 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 272 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 273 | The object takes the form of: |
| 274 | |
| 275 | { # Store resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 276 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 277 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 278 | "storeAddress": "A String", # Required. The street address of the store. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 279 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 282 | x__xgafv: string, V1 error format. |
| 283 | Allowed values |
| 284 | 1 - v1 error format |
| 285 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 286 | |
| 287 | Returns: |
| 288 | An object of the form: |
| 289 | |
| 290 | { # Store resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 291 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 292 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 293 | "storeAddress": "A String", # Required. The street address of the store. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 294 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 295 | </div> |
| 296 | |
| 297 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 298 | <code class="details" id="inventory">inventory(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 299 | <pre>Submit inventory for the given merchant. |
| 300 | |
| 301 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 304 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 305 | The object takes the form of: |
| 306 | |
| 307 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 308 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 309 | "quantity": "A String", # Required. The available quantity of the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 310 | "gtin": "A String", # Global Trade Item Number. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 311 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 312 | "itemId": "A String", # Required. A unique identifier for the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 313 | "price": { # Required. The current price of the item. |
| 314 | "currency": "A String", # The currency of the price. |
| 315 | "value": "A String", # The price represented as a number. |
| 316 | }, |
| 317 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 318 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 319 | } |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 322 | x__xgafv: string, V1 error format. |
| 323 | Allowed values |
| 324 | 1 - v1 error format |
| 325 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 326 | |
| 327 | Returns: |
| 328 | An object of the form: |
| 329 | |
| 330 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 331 | "gtin": "A String", # Global Trade Item Number. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 332 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse". |
| 333 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 334 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 335 | "itemId": "A String", # Required. A unique identifier for the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 336 | "price": { # Required. The current price of the item. |
| 337 | "currency": "A String", # The currency of the price. |
| 338 | "value": "A String", # The price represented as a number. |
| 339 | }, |
| 340 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 341 | "quantity": "A String", # Required. The available quantity of the item. |
| 342 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 343 | }</pre> |
| 344 | </div> |
| 345 | |
| 346 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 347 | <code class="details" id="list">list(merchantId, targetMerchantId, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 348 | <pre>Lists the stores of the target merchant. |
| 349 | |
| 350 | Args: |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 353 | x__xgafv: string, V1 error format. |
| 354 | Allowed values |
| 355 | 1 - v1 error format |
| 356 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 357 | |
| 358 | Returns: |
| 359 | An object of the form: |
| 360 | |
| 361 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | "resources": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 363 | { # Store resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 364 | "storeCode": "A String", # Required. A store identifier that is unique for the given merchant. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 365 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 366 | "storeAddress": "A String", # Required. The street address of the store. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 367 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 368 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 369 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 370 | }</pre> |
| 371 | </div> |
| 372 | |
| 373 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 374 | <code class="details" id="sale">sale(merchantId, targetMerchantId, body=None, dryRun=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | <pre>Submit a sale event for the given merchant. |
| 376 | |
| 377 | Args: |
| 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 380 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 381 | The object takes the form of: |
| 382 | |
| 383 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 384 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 385 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 386 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 387 | "saleId": "A String", # A unique ID to group items from the same sale event. |
| 388 | "price": { # Required. The price of the item. |
| 389 | "currency": "A String", # The currency of the price. |
| 390 | "value": "A String", # The price represented as a number. |
| 391 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 392 | "gtin": "A String", # Global Trade Item Number. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 393 | "itemId": "A String", # Required. A unique identifier for the item. |
| 394 | "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. |
| 395 | "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 396 | } |
| 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 Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 399 | x__xgafv: string, V1 error format. |
| 400 | Allowed values |
| 401 | 1 - v1 error format |
| 402 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 403 | |
| 404 | Returns: |
| 405 | An object of the form: |
| 406 | |
| 407 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 408 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse". |
| 409 | "gtin": "A String", # Global Trade Item Number. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 410 | "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. |
| 411 | "quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 412 | "itemId": "A String", # Required. A unique identifier for the item. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 413 | "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format. |
| 414 | "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| 415 | "saleId": "A String", # A unique ID to group items from the same sale event. |
| 416 | "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| 417 | "price": { # Required. The price of the item. |
| 418 | "currency": "A String", # The currency of the price. |
| 419 | "value": "A String", # The price represented as a number. |
| 420 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 421 | }</pre> |
| 422 | </div> |
| 423 | |
| 424 | </body></html> |