Content API for Shopping . accounttax

Instance Methods

custombatch(body=*, dryRun=None)

Retrieves and updates tax settings of multiple accounts in a single request.

get(merchantId=*, accountId=*)

Retrieves the tax settings of the account.

list(merchantId=*, pageToken=None, maxResults=None)

Lists the tax settings of the sub-accounts in your Merchant Center account.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

patch(merchantId=*, accountId=*, body=*, dryRun=None)

Updates the tax settings of the account. This method supports patch semantics.

update(merchantId=*, accountId=*, body=*, dryRun=None)

Updates the tax settings of the account.

Method Details

custombatch(body=*, dryRun=None)
Retrieves and updates tax settings of multiple accounts in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accounttax request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The account tax settings to update. Only defined if the method is update.
          "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
            { # Tax calculation rule to apply in a state or province (USA only).
              "country": "A String", # Country code in which tax is applicable.
              "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
              "shippingTaxed": True or False, # If true, shipping charges are also taxed.
              "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
              "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
            },
          ],
          "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
          "accountId": "A String", # The ID of the account to which these account tax settings belong.
        },
        "merchantId": "A String", # The ID of the managing account.
        "accountId": "A String", # The ID of the account for which to get/update account tax settings.
      },
    ],
  }

  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Returns:
  An object of the form:

    {
    "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accounttax response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "accountTax": { # The tax settings of a merchant account. All methods require the admin role. # The retrieved or updated account tax settings.
          "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
            { # Tax calculation rule to apply in a state or province (USA only).
              "country": "A String", # Country code in which tax is applicable.
              "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
              "shippingTaxed": True or False, # If true, shipping charges are also taxed.
              "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
              "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
            },
          ],
          "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
          "accountId": "A String", # The ID of the account to which these account tax settings belong.
        },
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".
      },
    ],
  }
get(merchantId=*, accountId=*)
Retrieves the tax settings of the account.

Args:
  merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)

Returns:
  An object of the form:

    { # The tax settings of a merchant account. All methods require the admin role.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }
list(merchantId=*, pageToken=None, maxResults=None)
Lists the tax settings of the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of tax settings to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
    "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
    "resources": [
      { # The tax settings of a merchant account. All methods require the admin role.
        "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
          { # Tax calculation rule to apply in a state or province (USA only).
            "country": "A String", # Country code in which tax is applicable.
            "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
            "shippingTaxed": True or False, # If true, shipping charges are also taxed.
            "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
            "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
          },
        ],
        "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
        "accountId": "A String", # The ID of the account to which these account tax settings belong.
      },
    ],
  }
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(merchantId=*, accountId=*, body=*, dryRun=None)
Updates the tax settings of the account. This method supports patch semantics.

Args:
  merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The tax settings of a merchant account. All methods require the admin role.
  "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    { # Tax calculation rule to apply in a state or province (USA only).
      "country": "A String", # Country code in which tax is applicable.
      "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
      "shippingTaxed": True or False, # If true, shipping charges are also taxed.
      "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
      "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    },
  ],
  "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
  "accountId": "A String", # The ID of the account to which these account tax settings belong.
}

  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Returns:
  An object of the form:

    { # The tax settings of a merchant account. All methods require the admin role.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }
update(merchantId=*, accountId=*, body=*, dryRun=None)
Updates the tax settings of the account.

Args:
  merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The tax settings of a merchant account. All methods require the admin role.
  "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    { # Tax calculation rule to apply in a state or province (USA only).
      "country": "A String", # Country code in which tax is applicable.
      "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
      "shippingTaxed": True or False, # If true, shipping charges are also taxed.
      "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
      "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    },
  ],
  "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
  "accountId": "A String", # The ID of the account to which these account tax settings belong.
}

  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Returns:
  An object of the form:

    { # The tax settings of a merchant account. All methods require the admin role.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }