Content API for Shopping . localinventory

Instance Methods

custombatch(body=None)

Updates local inventory for multiple products or stores in a single request.

insert(merchantId, productId, body=None)

Update the local inventory of a product in your Merchant Center account.

Method Details

custombatch(body=None)
Updates local inventory for multiple products or stores 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.
      { # Batch entry encoding a single local inventory update request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "localInventory": { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification. # Local inventory of the product.
          "availability": "A String", # Availability of the product.
          "instoreProductLocation": "A String", # In-store product location.
          "kind": "content#localInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
          "pickupMethod": "A String", # Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`.
          "pickupSla": "A String", # Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`.
          "price": { # Price of the product.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantity": 42, # Quantity of the product. Must be nonnegative.
          "salePrice": { # Sale price of the product. Mandatory if `sale_price_effective_date` is defined.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.
          "storeCode": "A String", # Required. Store code of this local inventory resource.
        },
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String", # Method of the batch request entry.
            #
            # Acceptable values are:
            # - "`insert`"
        "productId": "A String", # The ID of the product for which to update local inventory.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "entries": [ # The result of the execution of the batch requests.
      { # Batch entry encoding a single local inventory update response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "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`.
        },
        "kind": "content#localinventoryCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#localinventoryCustomBatchResponseEntry`"
      },
    ],
    "kind": "content#localinventoryCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#localinventoryCustomBatchResponse".
  }
insert(merchantId, productId, body=None)
Update the local inventory of a product in your Merchant Center account.

Args:
  merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
  productId: string, The REST ID of the product for which to update local inventory. (required)
  body: object, The request body.
    The object takes the form of:

{ # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
  "availability": "A String", # Availability of the product.
  "instoreProductLocation": "A String", # In-store product location.
  "kind": "content#localInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
  "pickupMethod": "A String", # Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`.
  "pickupSla": "A String", # Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`.
  "price": { # Price of the product.
    "currency": "A String", # The currency of the price.
    "value": "A String", # The price represented as a number.
  },
  "quantity": 42, # Quantity of the product. Must be nonnegative.
  "salePrice": { # Sale price of the product. Mandatory if `sale_price_effective_date` is defined.
    "currency": "A String", # The currency of the price.
    "value": "A String", # The price represented as a number.
  },
  "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.
  "storeCode": "A String", # Required. Store code of this local inventory resource.
}


Returns:
  An object of the form:

    { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
    "availability": "A String", # Availability of the product.
    "instoreProductLocation": "A String", # In-store product location.
    "kind": "content#localInventory", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
    "pickupMethod": "A String", # Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`.
    "pickupSla": "A String", # Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`.
    "price": { # Price of the product.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "quantity": 42, # Quantity of the product. Must be nonnegative.
    "salePrice": { # Sale price of the product. Mandatory if `sale_price_effective_date` is defined.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.
    "storeCode": "A String", # Required. Store code of this local inventory resource.
  }