Method: pos.inventory

AI-generated Key Takeaways

Submits inventory data for a given merchant using the POST method.
Requires providing merchant ID, target merchant ID, and inventory data in the request.
The request body should contain details like store code, item ID, price, quantity, and timestamp.
The response provides a confirmation with details like kind, store code, item ID, and other relevant information.
Utilizes the https://www.googleapis.com/auth/content OAuth scope for authorization.

HTTP request
Path parameters
Request body
Response body
- JSON representation
Authorization scopes
PosInventoryRequest
- JSON representation
Try it!

Submit inventory for the given merchant.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/pos/{targetMerchantId}/inventory

Path parameters

Parameters

Parameters
`merchantId`	`string` The ID of the POS or inventory data provider.
`targetMerchantId`	`string` The ID of the target merchant.

merchantId

string

The ID of the POS or inventory data provider.

targetMerchantId

string

The ID of the target merchant.

Request body

The request body contains an instance of PosInventoryRequest .

Response body

If successful, the response body contains data with the following structure:

JSON representation

JSON representation
{ "kind" : string , "storeCode" : string , "itemId" : string , "targetCountry" : string , "contentLanguage" : string , "gtin" : string , "price" : { object ( `Price` ) } , "quantity" : string , "timestamp" : string , "pickupMethod" : string , "pickupSla" : string }

 { 
 "kind" 
 : 
 string 
 , 
 "storeCode" 
 : 
 string 
 , 
 "itemId" 
 : 
 string 
 , 
 "targetCountry" 
 : 
 string 
 , 
 "contentLanguage" 
 : 
 string 
 , 
 "gtin" 
 : 
 string 
 , 
 "price" 
 : 
 { 
 object (  Price 
 
) 
 } 
 , 
 "quantity" 
 : 
 string 
 , 
 "timestamp" 
 : 
 string 
 , 
 "pickupMethod" 
 : 
 string 
 , 
 "pickupSla" 
 : 
 string 
 }

Fields
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string " `content#posInventoryResponse` ".
`storeCode`	`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.
`itemId`	`string` Required. A unique identifier for the item.
`targetCountry`	`string` Required. The CLDR territory code for the item.
`contentLanguage`	`string` Required. The two-letter ISO 639-1 language code for the item.
`gtin`	`string` Global Trade Item Number.
`price`	`object ( Price )` Required. The current price of the item.
`quantity`	`string ( int64 format)` Required. The available quantity of the item.
`timestamp`	`string` Required. The inventory timestamp, in ISO 8601 format.
`pickupMethod`	`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 .
`pickupSla`	`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 .

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview .

PosInventoryRequest