Method: pos.custombatch

    Batches multiple POS-related calls in a single request.

    HTTP request

    POST https://shoppingcontent.googleapis.com/content/v2.1/pos/batch

    Request body

    The request body contains an instance of PosCustomBatchRequest .

    Response body

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

    JSON representation 
     { 
 "entries" 
 : 
 [ 
 { 
 object (  PosCustomBatchResponseEntry 
 
) 
 } 
 ] 
 , 
 "kind" 
 : 
 string 
 }
    Fields
    entries[]

    object ( PosCustomBatchResponseEntry )

    The result of the execution of the batch requests.
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string " content#posCustomBatchResponse ".

    Authorization scopes

    Requires one of the following OAuth scopes:

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

    For more information, see the OAuth 2.0 Overview .

    PosCustomBatchRequest

    JSON representation 
     { 
 "entries" 
 : 
 [ 
 { 
 object (  PosCustomBatchRequestEntry 
 
) 
 } 
 ] 
 }
    Fields
    entries[]

    object ( PosCustomBatchRequestEntry )

    The request entries to be processed in the batch.

    PosCustomBatchRequestEntry

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "merchantId" 
 : 
 string 
 , 
 "method" 
 : 
 string 
 , 
 "targetMerchantId" 
 : 
 string 
 , 
 "storeCode" 
 : 
 string 
 , 
 "store" 
 : 
 { 
 object (  PosStore 
 
) 
 } 
 , 
 "inventory" 
 : 
 { 
 object (  PosInventory 
 
) 
 } 
 , 
 "sale" 
 : 
 { 
 object (  PosSale 
 
) 
 } 
 }
    Fields
    batchId

    integer ( uint32 format)

    An entry ID, unique within the batch request.

    merchantId

    string

    The ID of the POS data provider.

    method

    string

    The method of the batch entry.

    Acceptable values are:

    • " delete "
    • " get "
    • " insert "
    • " inventory "
    • " sale "
    targetMerchantId

    string

    The ID of the account for which to get/submit data.

    storeCode

    string

    The store code. This should be set only if the method is delete or get .

    store

    object ( PosStore )

    The store information to submit. This should be set only if the method is insert .

    inventory

    object ( PosInventory )

    The inventory to submit. This should be set only if the method is inventory .

    sale

    object ( PosSale )

    The sale information to submit. This should be set only if the method is sale .

    PosInventory

    The absolute quantity of an item available at the given store.

    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 
 }
    Fields
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string " content#posInventory "
    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 .

    PosSale

    The change of the available quantity of an item at the given store.

    JSON representation 
     { 
 "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#posSale "
    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.

    PosCustomBatchResponseEntry

    JSON representation 
     { 
 "batchId" 
 : 
 integer 
 , 
 "store" 
 : 
 { 
 object (  PosStore 
 
) 
 } 
 , 
 "errors" 
 : 
 { 
 object (  Errors 
 
) 
 } 
 , 
 "inventory" 
 : 
 { 
 object (  PosInventory 
 
) 
 } 
 , 
 "sale" 
 : 
 { 
 object (  PosSale 
 
) 
 } 
 , 
 "kind" 
 : 
 string 
 }
    Fields
    batchId

    integer ( uint32 format)

    The ID of the request entry to which this entry responds.
    store

    object ( PosStore )

    The retrieved or updated store information.
    errors

    object ( Errors )

    A list of errors defined if, and only if, the request failed.
    inventory

    object ( PosInventory )

    The updated inventory information.
    sale

    object ( PosSale )

    The updated sale information.
    kind

    string

    Identifies what kind of resource this is. Value: the fixed string " content#posCustomBatchResponseEntry "
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: