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