# Content API for Shopping . pos

## Instance Methods

Batches multiple POS-related calls in a single request.

Deletes a store for the given merchant.

Retrieves information about the given store.

Creates a store for the given merchant.

Submit inventory for the given merchant.

Lists the stores of the target merchant.

Submit a sale event for the given merchant.

### Method Details

`custombatch(body=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. Set this 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": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
              "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 via the API or the code of the store in Google My Business.
              "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. Set this 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": "content#posSale", # 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 via the API or the code of the store in Google My Business.
              "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. Set this only if the method is `insert`.
              "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
              "storeAddress": "A String", # Required. The street address of the store.
              "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
            },
            "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.
          },
        ],
      }

    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": "content#posInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
              "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 via the API or the code of the store in Google My Business.
              "targetCountry": "A String", # Required. The CLDR territory code for the item.
              "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
            },
            "kind": "content#posCustomBatchResponseEntry", # 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": "content#posSale", # 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 via the API or the code of the store in Google My Business.
              "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.
              "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
              "storeAddress": "A String", # Required. The street address of the store.
              "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
            },
          },
        ],
        "kind": "content#posCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".
      }

`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.
        "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
        "storeAddress": "A String", # Required. The street address of the store.
        "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
      }

`insert(merchantId, targetMerchantId, body=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.
      "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
      "storeAddress": "A String", # Required. The street address of the store.
      "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
    }

    Returns:
      An object of the form:

        { # Store resource.
        "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
        "storeAddress": "A String", # Required. The street address of the store.
        "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
      }

`inventory(merchantId, targetMerchantId, body=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.
        "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 via the API or the code of the store in Google My Business.
        "targetCountry": "A String", # Required. The CLDR territory code for the item.
        "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 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": "content#posInventoryResponse", # Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
        "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 via the API or the code of the store in Google My Business.
        "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)`

    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.
            "kind": "content#posStore", # Identifies what kind of resource this is. Value: the fixed string "`content#posStore`"
            "storeAddress": "A String", # Required. The street address of the store.
            "storeCode": "A String", # Required. A store identifier that is unique for the given merchant.
          },
        ],
      }

`sale(merchantId, targetMerchantId, body=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 via the API or the code of the store in Google My Business.
        "targetCountry": "A String", # Required. The CLDR territory code for the item.
        "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 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": "content#posSaleResponse", # 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 via the API or the code of the store in Google My Business.
        "targetCountry": "A String", # Required. The CLDR territory code for the item.
        "timestamp": "A String", # Required. The inventory timestamp, in ISO 8601 format.
      }