XML API Tag Reference
This document contains definitions for all of the
XML elements discussed in the Google Checkout XML API Developer's Guide. This list includes the XML tags and attributes used in the Checkout API,
the Merchant Calculations API,
the Notification API and the Order Processing API.
The tables below, which contain the XML tag definitions, are ordered alphabetically by XML tag name. In addition to the tag definition, the tables also define the attributes of each tag. In addition, each table lists the parent and child XML tags for each tag, the content format of the tag, and an example that shows how the XML tag appears in an API request or response.
Certain symbols may be displayed next to some subtags in the definitions below. These symbols, and their meanings, are:
? = optional subtag
* = zero or more instances of the subtag
You can use the table below to jump to tags starting with a particular letter.
| accept-gift-certificates |
| Definition |
The <accept-gift-certificates> tag indicates whether customers should be able to apply gift certificates to their order totals. If this tag has a value of true, then Google Checkout will display an option for customers to enter gift certificate codes. These codes will then be passed to the merchant in a merchant-calculation-callback request. |
| Subtag of |
merchant-calculations |
| API Commands |
Checkout |
| Content Format |
Boolean |
| Example |
<accept-gift-certificates>true</accept-gift-certificates> |
| accept-merchant-coupons |
| Definition |
The <accept-merchant-coupons> tag indicates whether customers should be able to apply coupon codes to their order totals. If this tag has a value of true, then Google Checkout will display an option for customers to enter coupon codes. These codes will then be passed to the merchant in a merchant-calculation-callback request. |
| Subtag of |
merchant-calculations |
| API Commands |
Checkout |
| Content Format |
Boolean |
| Example |
<accept-merchant-coupons>true</accept-merchant-coupons> |
| add-merchant-order-number |
| Definition |
The <add-merchant-order-number> tag instructs Google Checkout to attach a merchant-assigned order number to an order. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
merchant-order-number |
| API Commands |
Add Merchant Order Number |
| Content Format |
Container |
| Example |
<add-merchant-order-number xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| add-tracking-data |
| Definition |
The <add-tracking-data> tag contains a request to add a shipper's tracking number to an order. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
tracking-data |
| API Commands |
Add Tracking Data |
| Content Format |
Container |
| Example |
<add-tracking-data xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| additional-fixed-charge |
| Definition |
The <additional-fixed-charge> tag allows you to specify a fixed charge that will be added to the total cost of an order if the buyer selects the associated shipping option. If you also adjust the calculated shipping cost using the <additional-variable-charge-percent> tag, the fixed charge will be added to the adjusted shipping rate. |
| Attributes |
| Name | Format | Description |
| currency |
String |
The currency attribute identifies the unit of currency associated with the tag's value. The value of the currency attribute must be a three-letter ISO 4217 currency code. |
|
| Subtag of |
carrier-calculated-shipping-option |
| Content Format |
Double |
| Example |
<additional-fixed-charge currency="USD">5.00</additional-fixed-charge> |
| additional-variable-charge-percent |
| Definition |
The <additional-variable-charge-percent> tag specifies a percentage amount by which a carrier-calculated shipping rate will be adjusted. The tag's value may be positive or negative. For example, if the tag's value is 15, then the carrier's shipping rate will effectively be multiplied by 1.15 to determine the shipping cost presented to the buyer. So, if the carrier shipping rate were $10.00, the adjusted shipping rate would be $11.50 – i.e. $10.00 + ($10.00 X 15%). If the <additional-variable-charge-percent> tag value is negative, the calculated shipping rate will be discounted by the specified percentage. |
| Subtag of |
carrier-calculated-shipping-option |
| Content Format |
Double |
| Example |
<additional-variable-charge-percent>10</additional-variable-charge-percent> |
| address-filters |
| Definition |
The <address-filters> tag identifies areas where a particular merchant-calculated shipping method is available or unavailable. Address filters are applied before Google Checkout sends a <merchant-calculation-callback> to the merchant. Google Checkout will not ask you to calculate the cost of a particular shipping method for an address if the address filters in the Checkout API request indicate that the method is not available for the address. |
| Subtag of |
merchant-calculated-shipping |
| Subtags |
allow-us-po-box?, allowed-areas, excluded-areas? |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<address-filters>false</address-filters> |
| adjustment-total |
| Definition |
The <adjustment-total> tag contains the total adjustment to an order total based on tax, shipping, gift certificates and coupon codes. |
| Attributes |
| Name | Format | Description |
| currency |
String |
The currency attribute identifies the unit of currency associated with the tag's value. The value of the currency attribute must be a three-letter ISO 4217 currency code. |
|
| Subtag of |
order-adjustment |
| API Commands |
New Order Notification |
| Content Format |
Decimal |
| Example |
<adjustment-total currency="USD">11.05</adjustment-total> |
| allow-us-po-box |
| Definition |
The <allow-us-po-box> tag indicates whether a particular shipping method can be used to ship an order to a U.S. post office (P.O.) box. To prevent a flat-rate shipping option from being offered to customers who are shipping orders to P.O. boxes in the United States, include this tag with a value of false in the shipping-restrictions for the shipping option. The default value for this tag is true. |
| Subtag of |
shipping-restrictions, address-filters |
| API Commands |
Checkout |
| Content Format |
Boolean |
| Example |
<allow-us-po-box>false</allow-us-po-box> |
| alternate-tax-rule |
| Definition |
The <alternate-tax-rule> tag contains information about a tax rule that should be applied in a particular area. Each tax rule must contain either exactly one <tax-area> tag or exactly one <tax-areas> tag. |
| Subtag of |
alternate-tax-rules |
| Subtags |
rate, tax-area?, tax-areas? |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<alternate-tax-rule> |
| alternate-tax-rules |
| Definition |
The <alternate-tax-rules> tag contains information about the taxes applied in specific areas, such as states, zip codes or postal codes. The <alternate-tax-rules> element contains a list of one or more <alternate-tax-rule> elements. These rules override the <tax-rules> for an order. |
| Subtag of |
alternate-tax-table |
| Subtags |
alternate-tax-rule* |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<alternate-tax-rules> |
| alternate-tax-table |
| Definition |
The <alternate-tax-table> tag contains information about an individual tax table, which constitutes a set of alternate-tax-rules. |
| Attributes |
| Name | Format | Description |
| name |
String |
The name attribute value contains a string that can be used to identify a tax table or shipping method. The attribute value must be at least one non-space character and may not be longer than 255 characters. |
| standalone |
Boolean |
The standalone attribute indicates how taxes should be calculated if there is no matching alternate-tax-rule for the given state, zip code or country area. If this attribute's value is TRUE and there is no matching alternate-tax-rule, the tax amount will be zero. If the attribute's value is FALSE and there is no matching alternate-tax-rule, the tax amount will be calculated using the default tax table. |
|
| Subtag of |
alternate-tax-tables |
| Subtags |
alternate-tax-rules |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<alternate-tax-table standalone="true" name="Ventura County"> |
| alternate-tax-tables |
| Definition |
The <alternate-tax-tables> tag contains a list of one or more alternate-tax-table elements. Alternate tax tables override the rules defined in the default-tax-table. |
| Subtag of |
tax-tables |
| Subtags |
alternate-tax-table* |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<alternate-tax-tables standalone="true" name="Ventura County"> |
| amount |
| Definition |
The <amount> tag identifies the amount of money to charge or refund for an order. The tag's value may either be the full amount of the order or a partial amount. If this tag is omitted and as a part of a charge-order command, Google will charge the customer for the full amount of the order. If this tag is omitted as a part of a refund-order command, Google will refund the full order amount to the customer. This tag has one required attribute, which identifies the currency of the amount to be charged or refunded. |
| Attributes |
| Name | Format | Description |
| currency |
String |
The currency attribute identifies the unit of currency associated with the tag's value. The value of the currency attribute must be a three-letter ISO 4217 currency code. |
|
| Subtag of |
charge-order, refund-order |
| API Commands |
Charge Order, Refund Order |
| Content Format |
Decimal |
| Example |
<amount currency="USD">129.43</amount> |
| analytics-data |
| Definition |
The <analytics-data> tag enables merchants that submit server-to-server Checkout API requests to use Google Analytics to track Checkout orders. The Using Google Analytics to Track Google Checkout Orders document explains how to retrieve the appropriate value for this tag. |
| Subtag of |
merchant-checkout-flow-support |
| Content Format |
String |
| Example |
<analytics-data>SW5zZXJ0IDxhbmFseXRpY3MtZGF0YT4gdmFsdWUgaGVyZS4=</analytics-data> |
| anonymous-address |
| Definition |
The <anonymous-address> tag contains a possible shipping address for an order. This address should be used to calculate taxes and shipping costs for the order. |
| Attributes |
| Name | Format | Description |
| id |
String |
The id attribute specifies a unique value that identifies a particular address. |
|
| Subtag of |
addresses |
| Subtags |
city, region, postal-code, country-code |
| API Commands |
Merchant Calculation Callback |
| Content Format |
Complex |
| Example |
<anonymous-address id="BuyerAddress"> |
| applied-amount |
| Definition |
The <applied-amount> tag contains the amount of a coupon or gift certificate that was applied to an order total. |
| Attributes |
| Name | Format | Description |
| currency |
String |
The currency attribute identifies the unit of currency associated with the tag's value. The value of the currency attribute must be a three-letter ISO 4217 currency code. |
|
| Subtag of |
coupon-adjustment, gift-certificate-adjustment |
| API Commands |
New Order Notification |
| Content Format |
Decimal |
| Example |
<applied-amount currency="USD">11.05</applied-amount> |
| archive-order |
| Definition |
The <archive-order> tag indicates a request to archive a particular order. You would archive an order to remove it from your Merchant Center Inbox, indicating that the order has been delivered. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| API Commands |
Archive Order |
| Content Format |
Empty |
| Example |
<archive-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> |
| authorization-amount |
| Definition |
The <authorization-amount> tag contains the amount that was reauthorized to be charged to the customer's credit card. Google guarantees that these funds will be available for seven days – 168 hours – from the time that the reauthorization takes place. |
| Attributes |
| Name | Format | Description |
| currency |
String |
The currency attribute identifies the unit of currency associated with the tag's value. The value of the currency attribute must be a three-letter ISO 4217 currency code. |
|
| Subtag of |
authorization-amount-notification |
| API Commands |
Authorization Amount Notification |
| Content Format |
Decimal |
| Example |
<authorization-amount currency="USD">50.00</authorization-amount> |
| authorization-expiration-date |
| Definition |
The <authorization-expiration-date> tag identifies the time that a credit card authorization for an order expires. |
| Subtag of |
authorization-amount-notification |
| API Commands |
Authorization Amount Notification |
| Content Format |
Date/Time |
| Example |
<authorization-expiration-date>2007-03-26T15:06:26.000Z</authorization-expiration-date> |
| authorize-order |
| Definition |
The <authorize-order> tag contains a request to reauthorize an order. There are several possible consequences of the request: If the reauthorization is successful, and the customer has not been partially charged for the order, the order's financial-order-state will update to CHARGEABLE. If the reauthorization is successful, but the customer has already been partially charged for the order, the order's financial-order-state will update to (or remain at) CHARGED. If the reauthorization is unsuccessful, the order's financial-order-state will update to PAYMENT_DECLINED. In this case, the customer will have 72 hours to submit a new card.
|
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| API Commands |
Authorize Order |
| Content Format |
Container |
| Example |
<authorize-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> |
| backorder-items |
| Definition |
The <backorder-items> command lets you specify that one or more specific items in an order are out of stock. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
item-ids, send-email? |
| Content Format |
Container |
| Example |
<backorder-items xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| billing-address |
| Definition |
The <billing-address> tag contains information about the buyer's billing address. |
| Subtag of |
risk-information |
| Subtags |
address1, address2?, city, company-name?, contact-name, country-code, email?, fax?, phone?, postal-code, region |
| API Commands |
Risk Information Notification |
| Content Format |
Complex? |
| Example |
<billing-address> |
| buyer-account-age |
| Definition |
The <buyer-account-age> tag identifies the age, in days, of the buyer's Google Checkout account. |
| Subtag of |
risk-information |
| API Commands |
Risk Information Notification |
| Content Format |
Integer |
| Example |
<buyer-account-age>6</buyer-account-age> |
| buyer-billing-address |
| Definition |
The <buyer-billing-address> tag contains the billing address associated with an order. |
| Subtag of |
new-order-notification |
| Subtags |
address1, address2?, city, company-name?, contact-name?, country-code, email?, fax?, phone?, postal-code, region |
| API Commands |
New Order Notification |
| Content Format |
Complex |
| Example |
<buyer-billing-address> |
| buyer-language |
| Definition |
The <buyer-language> tag identifies the customer's user interface language. At this time, this value is always en_US. |
| Subtag of |
merchant-calculation-callback |
| API Commands |
Merchant Calculation Callback |
| Content Format |
String |
| Example |
<buyer-language>en_US</buyer-language> |
| buyer-marketing-preferences |
| Definition |
The <buyer-marketing-preferences> tag contains information about the customer's contact preferences. |
| Subtag of |
new-order-notification |
| Subtags |
email-allowed |
| API Commands |
New Order Notification |
| Content Format |
Container |
| Example |
<buyer-marketing-preferences> |
| buyer-shipping-address |
| Definition |
The <buyer-shipping-address> tag contains the shipping address for an order. |
| Subtag of |
new-order-notification |
| Subtags |
address1, address2?, city, company-name?, contact-name?, country-code, email?, fax?, phone?, postal-code, region |
| API Commands |
New Order Notification |
| Content Format |
Complex |
| Example |
<buyer-shipping-address> |
| bye |
| Definition |
The <bye> response indicates that Google correctly received a <hello> request. |
| Attributes |
| Name | Format | Description |
| serial-number |
String |
The serial-number attribute contains an ID that uniquely identifies a Google Checkout notification. |
|
| Content Format |
Complex |
| Example |
<bye xmlns="http://checkout.google.com/schema/2" serial-number="c567262a-dd13-4084-b8d3-6ccfbbc69d03" /> |
| cancel-items |
| Definition |
The <cancel-items> command lets you specify that one or more specific items in an order have been cancelled, meaning they will not be delivered to the customer. You might cancel items from an order for a variety of reasons. For example, an item might be discontinued or a customer might request to remove an item that was mistakenly included in an order. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
reason, comment?, item-ids, send-email? |
| Content Format |
Container |
| Example |
<cancel-items xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| cancel-order |
| Definition |
The <cancel-order> tag identifies an order that should be canceled. A <cancel-order> command sets the financial-order-state and the fulfillment-order-state to canceled. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
comment?, reason |
| API Commands |
Cancel Order |
| Content Format |
Container |
| Example |
<cancel-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| carrier |
| Definition |
The <carrier> tag contains the name of the company responsible for shipping the item. Valid values for this tag are DHL, FedEx, UPS, UPS MI, UPS Mail Innovations, USPS and Other. Please note that UPS MI and UPS Mail Innovations both refer to the same UPS service. |
| Subtag of |
tracking-data |
| API Commands |
Add Tracking Data, Deliver Order |
| Content Format |
String |
| Example |
<carrier>UPS MI</carrier> |
| carrier-calculated-shipping |
| Definition |
The <carrier-calculated-shipping> tag contains information that Google will need to request shipping costs for an order from the shipment carrier. If you include a carrier-calculated shipping method in your Checkout API request, Google will obtain the shipping cost for the order based on the information that you provided and the shipping address selected by the buyer. |
| Subtag of |
shipping-methods |
| Subtags |
carrier-calculated-shipping-options, shipping-packages |
| Content Format |
Complex |
| Example |
<carrier-calculated-shipping> |
| carrier-calculated-shipping-adjustment |
| Definition |
The <carrier-calculated-shipping-adjustment> tag communicates to a merchant the carrier-calculated shipping rate that was charged to a buyer. |
| Subtag of |
shipping |
| Subtags |
shipping-name, shipping-cost |
| API Commands |
New Order Notification |
| Content Format |
Container |
| Example |
<carrier-calculated-shipping-adjustment> |
| carrier-calculated-shipping-options |
| Definition |
The <carrier-calculated-shipping-options> tag encapsulates information about all of the shipping methods for which Google Checkout should obtain shipping costs. |
| Subtag of |
carrier-calculated-shipping |
| Subtags |
carrier-calculated-shipping-option* |
| Content Format |
Container |
| Example |
<carrier-calculated-shipping-options> |
| carrier-pickup |
| Definition |
The <carrier-pickup> tag specifies how the package will be transferred from the merchant to the shipper. Valid values for this tag are REGULAR_PICKUP, SPECIAL_PICKUP and DROP_OFF. The default value for this tag is DROP_OFF. |
| Subtag of |
carrier-calculated-shipping-option |
| Content Format |
String |
| Example |
<carrier-pickup>REGULAR_PICKUP</carrier-pickup> |
| charge-order |
| Definition |
The <charge-order> tag identifies an order for which Google should charge the customer. The <charge-order> tag may specify whether the buyer should be charged the full amount or a partial amount. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
amount? |
| API Commands |
Charge Order |
| Content Format |
Container |
| Example |
<charge-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| checkout-flow-support |
| Definition |
The <checkout-flow-support> tag contains encapsulates information used to help the customer through the checkout process. |
| Subtag of |
checkout-shopping-cart |
| Subtags |
merchant-checkout-flow-support |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<checkout-flow-support> |
| checkout-redirect |
| Definition |
The <checkout-redirect> tag encapsulates the URL to which a customer should be redirected when a merchant submits a shopping cart using the server-to-server technique for posting Checkout API requests. |
| Attributes |
| Name | Format | Description |
| serial-number |
String |
The serial-number attribute contains an ID that uniquely identifies a Google Checkout notification. |
|
| Subtags |
redirect-url |
| API Commands |
Checkout Redirect |
| Content Format |
Container |
| Example |
<checkout-redirect serial-number="3c394432-8270-411b-9239-98c2c499f87f"> |
| comment |
| Definition |
The <comment> tag contains a comment related to a refunded or canceled order. Note: The maximum accepted length for the tag value is 140 characters. |
| Subtag of |
refund-order, cancel-order, cancel-items |
| API Commands |
Refund Order, Cancel Order |
| Content Format |
String |
| Example |
<comment>Refund processed by Bob Smith</comment> |
| continue-shopping-url |
| Definition |
The <continue-shopping-url> tag contains a URL that allows the buyer to continue shopping after confirming an order. |
| Subtag of |
merchant-checkout-flow-support |
| API Commands |
Checkout |
| Content Format |
String (URL) |
| Example |
<continue-shopping-url> http://www.example.com/more_shopping </continue-shopping-url> |
| date-time-zone |
| Definition |
The <date-time-zone> tag identifies the time zone that will be associated with the start date and end date for the report. The Order Creation Date field in the API output will also specify times in this time zone. This tag's default value is UTC, which correlates to Greenwich Mean Time (GMT). Please see the Date and Time Gateway for a list of valid time zone values. Please note that you must combine the name of the region (e.g. America) with the locale (e.g. Chicago) in the following format: America/Chicago. |
| Subtag of |
order-list-request |
| API Commands |
order report |
| Content Format |
String |
| Example |
<date-time-zone>America/New_York</date-time-zone> |
| default-tax-table |
| Definition |
The <default-tax-table> tag contains the default set of rules that should be used to calculate the tax for an order. |
| Subtag of |
tax-tables |
| Subtags |
tax-rules |
| API Commands |
Checkout |
| Content Format |
Container |
| Example |
<default-tax-table> |
| deliver-order |
| Definition |
The <deliver-order> tag indicates that Google should update an order's fulfillment order state to DELIVERED. This tag has one required attribute, which identifies the order to be updated. |
| Attributes |
| Name | Format | Description |
| google-order-number |
String |
The google-order-number attribute contains an ID that uniquely identifies an order. |
|
| Subtags |
tracking-data?, send-email? |
| API Commands |
Deliver Order |
| Content Format |
Container |
| Example |
<deliver-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> |
| delivery-address-category |
| Definition |
The <delivery-address-category> tag indicates whether the shipping method should be applied to a residential or a commercial address. Valid values for this tag are RESIDENTIAL and COMMERCIAL. |
| Subtag of |
shipping-package |
| Content Format |
String |
| Example |
<delivery-address-category>RESIDENTIAL</delivery-address-category> |
| demo-failure |
| Definition |
The <demo-failure> tag enables you to test your handling of Google Checkout error messages. When you send a <demo-failure> request, Google Checkout will always return an error in the synchronous response to your request. |
| Attributes |
| Name | Format | Description |
| message |
String (Limit 25 characters) |
The message attribute contains a short note that explains the cause of a Google Checkout error response. |
|
| API Commands |
Synchronous Responses |
| Content Format |
Empty |
| Example |
<demo-failure xmlns="http://checkout.google.com/schema/2" message="test error handling"/> |
| description |
| Definition |
As a subtag of <digital-content>, the <description> tag contains instructions for downloading a digital content item. Please use the <item-description> tag to provide the description of the item being purchased. Note: This field has a maximum length of 1024 characters and may contain HTML tags. (HTML tags must be XML-escaped as described in the Google Checkout Developer's Guide.) As a subtag of <promotion>, the <description> tag contains information about a promotion that Google applied to an order. |
| Subtag of |
digital-content, promotion |
| Content Format |
String |
| Example |
<description>To download this item, link to the URL below and follow the instructions there. When prompted, enter the software key provided below.</description> |
| diagnosis |
| Definition |
The <diagnosis> tag contains a diagnostic response to an API request. The diagnostic response contains the parsed XML in your request as well as any warnings generated by your request. Please see the Validating XML Messages to Google Checkout section for more information about diagnostic requests and responses. |
| Attributes |
| Name | Format | Description |
| serial-number |
String |
The serial-number attribute contains an ID that uniquely identifies a Google Checkout notification. |
|
| Subtags |
input-xml, warnings? |
| API Commands |
Synchronous Responses |
| Content Format |
Container |
| Example |
<diagnosis xmlns="http://checkout.google.com/schema/2" serial-number="3c394432-8270-411b-9239-98c2c499f87f"> |
| display-disposition |
| Definition |
The <display-disposition> tag specifies when the buyer will be able to access purchased digital content. The only valid values for this tag are OPTIMISTIC and PESSIMISTIC. If the value of the <display-disposition> tag is OPTIMISTIC, then Google will display instructions for accessing the digital content as soon as the buyer confirms the order. We recommend that you only use optimistic delivery if you can easily revoke access to the digital content if Google cannot authorize the customer's credit card. If the value of the <display-disposition> tag is PESSIMISTIC, the buyer cannot access purchased digital content until his credit card has been authorized to be charged for the amount of the order.
The default value for this tag is PESSIMISTIC. |
| Subtag of |
digital-content |
| Content Format |
String |
| Example |
<display-disposition>OPTIMISTIC</display-disposition> |
| edit-cart-url |
| Definition |
The <edit-cart-url> tag contains a URL that allows the buyer to make changes to the shopping cart before confirming an order. |
| Subtag of |
merchant-checkout-flow-support |
| API Commands |
Checkout |
| Content Format |
String (URL) |
| Example |
<edit-cart-url> http://www.example.com/shopping.edit.php </edit-cart-url> |
| eligible-for-protection |
| Definition |
The <eligible-for-protection> tag indicates whether an order is eligible for Google Checkout's payment guarantee policy. |
| Subtag of |
risk-information |
| API Commands |
Risk Information Notification |
| Content Format |
Boolean |
| Example |
<eligible-for-protection>true</eligible-for-protection> |
| email-delivery |
| Definition |
The <email-delivery> tag indicates that the merchant will send email to the buyer explaining how to access the digital content. Email delivery allows the merchant to charge the buyer for an order before allowing the buyer to access the digital content. |
| Subtag of |
digital-content |
| Content Format |
Boolean |
| Example |
<email-delivery>true</email-delivery> |
| error |
| Definition |
The <error> tag contains information about an invalid API request. This information is intended to help you debug the problem causing the error. |
| Attributes |
| Name | Format | Description |
| serial-number |
String |
The serial-number attribute contains an ID that uniquely identifies a Google Checkout notification. |
|
| Subtags |
error-message, warning-messages? |
| API Commands |
Synchronous Responses |
| Content Format |
Container |
| Example |
<error xmlns="http://checkout.google.com/schema/2" serial-number="3c394432-8270-411b-9239-98c2c499f87f"> |
| error-message |
| Definition |
The <error-message> tag contains a message that describes why an API request caused an error. |
| Subtag of |
error |
| API Commands |
Synchronous Responses |
| Content Format |
Container |
| Example |
<error-message>Error: Illegal Argument</error-message> |
| financial-order-state |
| Definition |
|