Debian Codegraph @

docs/dyn/content_v2_1.pos.html

raw
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_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
111 Args:
112 body: object, The request body.
113 The object takes the form of:
114
115 {
116 &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;pickupMethod&quot;: &quot;A String&quot;, # Optional. Supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
125 &quot;pickupSla&quot;: &quot;A String&quot;, # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
126 &quot;price&quot;: { # Required. The current price of the item.
127 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
128 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
129 },
130 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
131 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
132 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
133 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
134 },
135 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
136 &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;
137 &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`.
138 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
139 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
140 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
141 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
142 &quot;price&quot;: { # Required. The price of the item.
143 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
144 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
145 },
146 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
147 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
148 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
149 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
150 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
151 },
152 &quot;store&quot;: { # Store resource. # The store information to submit. This should be set only if the method is `insert`.
153 &quot;gcidCategory&quot;: [ # The business type of the store.
154 &quot;A String&quot;,
155 ],
156 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
157 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
158 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
159 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
160 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
161 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
162 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
163 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
164 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
165 },
166 &quot;storeCode&quot;: &quot;A String&quot;, # The store code. This should be set only if the method is `delete` or `get`.
167 &quot;targetMerchantId&quot;: &quot;A String&quot;, # The ID of the account for which to get/submit data.
168 },
169 ],
170 }
171
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176
177 Returns:
178 An object of the form:
179
180 {
181 &quot;entries&quot;: [ # The result of the execution of the batch requests.
182 {
183 &quot;batchId&quot;: 42, # The ID of the request entry to which this entry responds.
184 &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.
185 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
186 &quot;errors&quot;: [ # A list of errors.
187 { # An error returned by the API.
188 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
189 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
190 &quot;reason&quot;: &quot;A String&quot;, # The error code.
191 },
192 ],
193 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
194 },
195 &quot;inventory&quot;: { # The absolute quantity of an item available at the given store. # The updated inventory information.
196 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
197 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
198 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
199 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventory`&quot;
200 &quot;pickupMethod&quot;: &quot;A String&quot;, # Optional. Supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
201 &quot;pickupSla&quot;: &quot;A String&quot;, # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
202 &quot;price&quot;: { # Required. The current price of the item.
203 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
204 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
205 },
206 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
207 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
208 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
209 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
210 },
211 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posCustomBatchResponseEntry`&quot;
212 &quot;sale&quot;: { # The change of the available quantity of an item at the given store. # The updated sale information.
213 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
214 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
215 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
216 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSale`&quot;
217 &quot;price&quot;: { # Required. The price of the item.
218 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
219 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
220 },
221 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
222 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
223 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
224 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
225 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
226 },
227 &quot;store&quot;: { # Store resource. # The retrieved or updated store information.
228 &quot;gcidCategory&quot;: [ # The business type of the store.
229 &quot;A String&quot;,
230 ],
231 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
232 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
233 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
234 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
235 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
236 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
237 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
238 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
239 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
240 },
241 },
242 ],
243 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posCustomBatchResponse`&quot;.
244 }</pre>
245 </div>
246
247 <div class="method">
248 <code class="details" id="delete">delete(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code>
249 <pre>Deletes a store for the given merchant.
250
251 Args:
252 merchantId: string, The ID of the POS or inventory data provider. (required)
253 targetMerchantId: string, The ID of the target merchant. (required)
254 storeCode: string, A store code that is unique per merchant. (required)
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259 </pre>
260 </div>
261
262 <div class="method">
263 <code class="details" id="get">get(merchantId, targetMerchantId, storeCode, x__xgafv=None)</code>
264 <pre>Retrieves information about the given store.
265
266 Args:
267 merchantId: string, The ID of the POS or inventory data provider. (required)
268 targetMerchantId: string, The ID of the target merchant. (required)
269 storeCode: string, A store code that is unique per merchant. (required)
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275 Returns:
276 An object of the form:
277
278 { # Store resource.
279 &quot;gcidCategory&quot;: [ # The business type of the store.
280 &quot;A String&quot;,
281 ],
282 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
283 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
284 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
285 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
286 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
287 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
288 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
289 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
290 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
291 }</pre>
292 </div>
293
294 <div class="method">
295 <code class="details" id="insert">insert(merchantId, targetMerchantId, body=None, x__xgafv=None)</code>
296 <pre>Creates a store for the given merchant.
297
298 Args:
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 { # Store resource.
305 &quot;gcidCategory&quot;: [ # The business type of the store.
306 &quot;A String&quot;,
307 ],
308 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
309 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
310 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
311 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
312 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
313 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
314 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
315 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
316 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
317 }
318
319 x__xgafv: string, V1 error format.
320 Allowed values
321 1 - v1 error format
322 2 - v2 error format
323
324 Returns:
325 An object of the form:
326
327 { # Store resource.
328 &quot;gcidCategory&quot;: [ # The business type of the store.
329 &quot;A String&quot;,
330 ],
331 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
332 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
333 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
334 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
335 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
336 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
337 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
338 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
339 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
340 }</pre>
341 </div>
342
343 <div class="method">
344 <code class="details" id="inventory">inventory(merchantId, targetMerchantId, body=None, x__xgafv=None)</code>
345 <pre>Submit inventory for the given merchant.
346
347 Args:
348 merchantId: string, The ID of the POS or inventory data provider. (required)
349 targetMerchantId: string, The ID of the target merchant. (required)
350 body: object, The request body.
351 The object takes the form of:
352
353 {
354 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
355 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
356 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
357 &quot;pickupMethod&quot;: &quot;A String&quot;, # Optional. Supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
358 &quot;pickupSla&quot;: &quot;A String&quot;, # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
359 &quot;price&quot;: { # Required. The current price of the item.
360 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
361 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
362 },
363 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
364 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
365 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
366 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
367 }
368
369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
373
374 Returns:
375 An object of the form:
376
377 {
378 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
379 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
380 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
381 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posInventoryResponse`&quot;.
382 &quot;pickupMethod&quot;: &quot;A String&quot;, # Optional. Supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
383 &quot;pickupSla&quot;: &quot;A String&quot;, # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
384 &quot;price&quot;: { # Required. The current price of the item.
385 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
386 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
387 },
388 &quot;quantity&quot;: &quot;A String&quot;, # Required. The available quantity of the item.
389 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
390 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
391 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
392 }</pre>
393 </div>
394
395 <div class="method">
396 <code class="details" id="list">list(merchantId, targetMerchantId, x__xgafv=None)</code>
397 <pre>Lists the stores of the target merchant.
398
399 Args:
400 merchantId: string, The ID of the POS or inventory data provider. (required)
401 targetMerchantId: string, The ID of the target merchant. (required)
402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
406
407 Returns:
408 An object of the form:
409
410 {
411 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posListResponse`&quot;.
412 &quot;resources&quot;: [
413 { # Store resource.
414 &quot;gcidCategory&quot;: [ # The business type of the store.
415 &quot;A String&quot;,
416 ],
417 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posStore`&quot;
418 &quot;matchingStatus&quot;: &quot;A String&quot;, # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - &quot;`matched`&quot;: The POS store is successfully matched with the Google Business Profile store. - &quot;`failed`&quot;: The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status.
419 &quot;matchingStatusHint&quot;: &quot;A String&quot;, # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - &quot;`linked-store-not-found`&quot;: There aren&#x27;t any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - &quot;`store-match-not-found`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores&#x27; addresses. Update POS store address or Google Business Profile store address to match correctly. - &quot;`store-match-unverified`&quot;: The provided POS store couldn&#x27;t be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.
420 &quot;phoneNumber&quot;: &quot;A String&quot;, # The store phone number.
421 &quot;placeId&quot;: &quot;A String&quot;, # The Google Place Id of the store location.
422 &quot;storeAddress&quot;: &quot;A String&quot;, # Required. The street address of the store.
423 &quot;storeCode&quot;: &quot;A String&quot;, # Required. A store identifier that is unique for the given merchant.
424 &quot;storeName&quot;: &quot;A String&quot;, # The merchant or store name.
425 &quot;websiteUrl&quot;: &quot;A String&quot;, # The website url for the store or merchant.
426 },
427 ],
428 }</pre>
429 </div>
430
431 <div class="method">
432 <code class="details" id="sale">sale(merchantId, targetMerchantId, body=None, x__xgafv=None)</code>
433 <pre>Submit a sale event for the given merchant.
434
435 Args:
436 merchantId: string, The ID of the POS or inventory data provider. (required)
437 targetMerchantId: string, The ID of the target merchant. (required)
438 body: object, The request body.
439 The object takes the form of:
440
441 {
442 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
443 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
444 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
445 &quot;price&quot;: { # Required. The price of the item.
446 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
447 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
448 },
449 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
450 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
451 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
452 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
453 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
454 }
455
456 x__xgafv: string, V1 error format.
457 Allowed values
458 1 - v1 error format
459 2 - v2 error format
460
461 Returns:
462 An object of the form:
463
464 {
465 &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The two-letter ISO 639-1 language code for the item.
466 &quot;gtin&quot;: &quot;A String&quot;, # Global Trade Item Number.
467 &quot;itemId&quot;: &quot;A String&quot;, # Required. A unique identifier for the item.
468 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#posSaleResponse`&quot;.
469 &quot;price&quot;: { # Required. The price of the item.
470 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
471 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
472 },
473 &quot;quantity&quot;: &quot;A String&quot;, # Required. The relative change of the available quantity. Negative for items returned.
474 &quot;saleId&quot;: &quot;A String&quot;, # A unique ID to group items from the same sale event.
475 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The identifier of the merchant&#x27;s store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
476 &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The CLDR territory code for the item.
477 &quot;timestamp&quot;: &quot;A String&quot;, # Required. The inventory timestamp, in ISO 8601 format.
478 }</pre>
479 </div>
480
481 </body></html>