Method: pos.sale

Page Summary

Submit sale events for a given merchant using the sale method.
The request body requires details like store code, item ID, price, quantity, and timestamp in the PosSaleRequest format.
Successful responses provide a posSaleResponse with details of the sale event including a unique sale ID.
This functionality requires authorization with the https://www.googleapis.com/auth/content scope.

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

Submit a sale event for the given merchant.

HTTP request

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

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 PosSaleRequest .

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 , "saleId" : string }

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

Fields
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string " `content#posSaleResponse` ".
`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 price of the item.
`quantity`	`string ( int64 format)` Required. The relative change of the available quantity. Negative for items returned.
`timestamp`	`string` Required. The inventory timestamp, in ISO 8601 format.
`saleId`	`string` A unique ID to group items from the same sale event.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview .

PosSaleRequest