Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Batches multiple POS-related calls in a single request.
delete(merchantId, targetMerchantId, storeCode, x__xgafv=None)
Deletes a store for the given merchant.
get(merchantId, targetMerchantId, storeCode, x__xgafv=None)
Retrieves information about the given store.
insert(merchantId, targetMerchantId, body=None, x__xgafv=None)
Creates a store for the given merchant.
inventory(merchantId, targetMerchantId, body=None, x__xgafv=None)
Submit inventory for the given merchant.
list(merchantId, targetMerchantId, x__xgafv=None)
Lists the stores of the target merchant.
sale(merchantId, targetMerchantId, body=None, x__xgafv=None)
Submit a sale event for the given merchant.
close()
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Batches multiple POS-related calls in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{
"batchId": 42, # An entry ID, unique within the batch request.
"inventory": { # The absolute quantity of an item available at the given store. # The inventory to submit. This should be set only if the method is `inventory`.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
"pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", 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).
"pickupSla": "A String", # 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).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"merchantId": "A String", # The ID of the POS data provider.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`"
"sale": { # The change of the available quantity of an item at the given store. # The sale information to submit. This should be set only if the method is `sale`.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"store": { # Store resource. # The store information to submit. This should be set only if the method is `insert`.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
"storeCode": "A String", # The store code. This should be set only if the method is `delete` or `get`.
"targetMerchantId": "A String", # The ID of the account for which to get/submit data.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{
"batchId": 42, # The ID of the request entry to which this entry responds.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"inventory": { # The absolute quantity of an item available at the given store. # The updated inventory information.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
"pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", 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).
"pickupSla": "A String", # 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).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`"
"sale": { # The change of the available quantity of an item at the given store. # The updated sale information.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSale`"
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
},
"store": { # Store resource. # The retrieved or updated store information.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponse`".
}
delete(merchantId, targetMerchantId, storeCode, x__xgafv=None)
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
get(merchantId, targetMerchantId, storeCode, x__xgafv=None)
Retrieves information about the given store.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
storeCode: string, A store code that is unique per merchant. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}
insert(merchantId, targetMerchantId, body=None, x__xgafv=None)
Creates a store for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
}
inventory(merchantId, targetMerchantId, body=None, x__xgafv=None)
Submit inventory for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", 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).
"pickupSla": "A String", # 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).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventoryResponse`".
"pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", 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).
"pickupSla": "A String", # 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).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The available quantity of the item.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
list(merchantId, targetMerchantId, x__xgafv=None)
Lists the stores of the target merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posListResponse`".
"resources": [
{ # Store resource.
"gcidCategory": [ # The business type of the store.
"A String",
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
"matchingStatus": "A String", # Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "`matched`": The POS store is successfully matched with the Google Business Profile store. - "`failed`": 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.
"matchingStatusHint": "A String", # Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "`linked-store-not-found`": There aren'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. - "`store-match-not-found`": The provided POS store couldn'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' addresses. Update POS store address or Google Business Profile store address to match correctly. - "`store-match-unverified`": The provided POS store couldn'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.
"phoneNumber": "A String", # The store phone number.
"placeId": "A String", # The Google Place Id of the store location.
"storeAddress": "A String", # Required. The street address of the store.
"storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
"storeName": "A String", # The merchant or store name.
"websiteUrl": "A String", # The website url for the store or merchant.
},
],
}
sale(merchantId, targetMerchantId, body=None, x__xgafv=None)
Submit a sale event for the given merchant.
Args:
merchantId: string, The ID of the POS or inventory data provider. (required)
targetMerchantId: string, The ID of the target merchant. (required)
body: object, The request body.
The object takes the form of:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posSaleResponse`".
"price": { # Required. The price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": "A String", # Required. The relative change of the available quantity. Negative for items returned.
"saleId": "A String", # A unique ID to group items from the same sale event.
"storeCode": "A String", # Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
}