| Note: This is the latest documentation. The previous version of this page is identical — only the left nav differs. |
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:
You can use the table below to jump to tags starting with a particular letter.
| A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | Q | R | S | T | U | V | W | Z |
| 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 |
|
||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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> |
| address1 | |
| Definition | The <address1> tag identifies the first line of the address to which an order is being shipped. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <address1>1600 Amphitheatre Parkway</address1> |
| address2 | |
| Definition | The <address2> tag identifies the second line of the address to which an order is being shipped. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <address2>Building 41</address2> |
| addresses | |
| Definition | The <addresses> tag contains information about shipping addresses for an order. |
| Subtag of | calculate |
| Subtags | anonymous-address* |
| API Commands | Merchant Calculation Callback |
| Content Format | Container |
| Example | <addresses> |
| 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 |
|
||||||
| 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> |
| allowed-areas | |
| Definition | The <allowed-areas> tag contains a list of regions where a shipping option is available. |
| Subtag of | shipping-restrictions, address-filters |
| Subtags | us-state-area*, us-zip-area*, us-country-area*, postal-area*, world-area? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <allowed-areas> |
| 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 |
|
|||||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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 |
|
||||||
| Subtag of | authorization-amount-notification | ||||||
| API Commands | Authorization Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <authorization-amount currency="USD">50.00</authorization-amount> | ||||||
| authorization-amount-notification | |||||||
| Definition | The <authorization-amount-notification> tag contains information about a successful reauthorization for an order. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, authorization-amount, authorization-expiration-date, avs-response, cvn-response, google-order-number, timestamp | ||||||
| API Commands | Authorization Amount Notification | ||||||
| Content Format | Container | ||||||
| Example | <authorization-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| 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:
|
||||||
| Attributes |
|
||||||
| API Commands | Authorize Order | ||||||
| Content Format | Container | ||||||
| Example | <authorize-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> | ||||||
| avs-response | |
| Definition | The <avs-response> tag contains an Address Verification System (AVS) response. Possible values for this tag are: Y - Full AVS match (address and postal code) P - Partial AVS match (postal code only) A - Partial AVS match (address only) N - no AVS match U - AVS not supported by issuer |
| Subtag of | risk-information, authorization-amount-notification |
| API Commands | Risk Information Notification, Authorization Amount Notification |
| Content Format | String |
| Example | <avs-response>Y</avs-response> |
| backorder-items | |||||||
| Definition | The <backorder-items> command lets you specify that one or more specific items in an order are out of stock. |
||||||
| Attributes |
|
||||||
| 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-id | |
| Definition | The <buyer-id> tag contains an ID that uniquely identifies the user to Google. |
| Subtag of | new-order-notification, merchant-calculation-callback |
| API Commands | New Order Notification, Merchant Calculation Callback |
| Content Format | Long |
| Example | <buyer-id>294873009217523</buyer-id> |
| 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 |
|
||||||
| Content Format | Complex | ||||||
| Example | <bye xmlns="http://checkout.google.com/schema/2" serial-number="c567262a-dd13-4084-b8d3-6ccfbbc69d03" /> |
||||||
| calculate | |
| Definition | The <calculate> tag contains details about calculations that the merchant should perform for an order. |
| Subtag of | merchant-calculation-callback |
| Subtags | addresses?, merchant-code-strings?, shipping?, tax |
| API Commands | Merchant Calculation Callback |
| Content Format | Container |
| Example | <calculate> |
| calculated-amount | |||||||
| Definition | The <calculated-amount> tag contains the calculated amount of a coupon or gift certificate. |
||||||
| Attributes |
|
||||||
| Subtag of | coupon-adjustment, gift-certificate-adjustment, coupon-result, gift-certificate-result | ||||||
| API Commands | New Order Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <calculated-amount currency="USD">11.05</calculated-amount> | ||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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-option | |
| Definition | The <carrier-calculated-shipping-option> tag contains information about a single shipping method for which Google Checkout should obtain shipping costs. |
| Subtag of | carrier-calculated-shipping-options |
| Subtags | price, shipping-company, carrier-pickup?, shipping-type, additional-fixed-charge?, additional-variable-charge-percent? |
| Content Format | Container |
| Example | <carrier-calculated-shipping-option> |
| 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> |
| cart-expiration | |
| Definition | The <cart-expiration> tag encapsulates information about the date that the cart expires. |
| Subtag of | shopping-cart |
| Subtags | good-until-date |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <cart-expiration> |
| charge-amount-notification | |||||||
| Definition | The <charge-amount-notification> tag contains information about a successful charge for an order. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, latest-charge-amount, latest-charge-fee?, latest-promotion-charge-amount?, total-charge-amount, timestamp | ||||||
| API Commands | Charge Amount Notification | ||||||
| Content Format | Container | ||||||
| Example | <charge-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| 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 |
|
||||||
| Subtags | amount? | ||||||
| API Commands | Charge Order | ||||||
| Content Format | Container | ||||||
| Example | <charge-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| chargeback-amount-notification | |||||||
| Definition | The <chargeback-amount-notification> tag contains information about a chargeback that Google Checkout processed for an order. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, latest-chargeback-amount, latest-chargeback-fee-amount?, latest-fee-refund-amount?, latest-promotion-chargeback-amount?, total-chargeback-amount, timestamp | ||||||
| API Commands | Chargeback Amount Notification | ||||||
| Content Format | Container | ||||||
| Example | <chargeback-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| 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 |
|
||||||
| Subtags | redirect-url | ||||||
| API Commands | Checkout Redirect | ||||||
| Content Format | Container | ||||||
| Example | <checkout-redirect serial-number="3c394432-8270-411b-9239-98c2c499f87f"> | ||||||
| checkout-shopping-cart | |
| Definition | The <checkout-shopping-cart> tag is the root tag for a Checkout API request and contains all checkout-related information. |
| Subtags | shopping-cart, checkout-flow-support, order-processing-support |
| API Commands | Checkout |
| Content Format | Container |
| Example | <checkout-shopping-cart> |
| city | |
| Definition | The <city> tag identifies the city associated with an order's billing or shipping address. |
| Subtag of | buyer-billing-address, buyer-shipping-address, anonymous-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification, Merchant Calculation Callback |
| Content Format | String |
| Example | <city>Mountain View</city> |
| code | |
| Definition | The <code> tag contains the code for a coupon or gift certificate that was applied to an order. |
| Subtag of | coupon-adjustment, gift-certificate-adjustment, coupon-result, gift-certificate-result |
| API Commands | Merchant Calculation Results, New Order Notification |
| Content Format | String |
| Example | <code>GiftCert12345</code> |
| 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> |
| company-name | |
| Definition | The <company-name> tag identifies the company to which an order is being shipped. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this tag will contain an empty value. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <company-name>Example.com Industries</company-name> |
| contact-name | |
| Definition | The <contact-name> tag identifies the person to whom an order is being shipped. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <contact-name>John McShopalot</contact-name> |
| 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> |
| country-code | |
| Definition | As a subtag of <postal-area>, the <country-code> tag specifies a country associated with a tax area, shipping restriction or address filter Note that Google Checkout does not allow you to ship orders to countries that are export-embargoed for the United States. Google Checkout will return an error if your shipping restrictions or address filters include one of these countries in a shipping area. For example, Iran (IR) and North Korea (KP) may not be included in a shipping area. In all other contexts, the <country-code> tag identifies the country code associated with an order's billing address or shipping address. The value of this tag must be a two-letter ISO 3166 country code. |
| Subtag of | buyer-billing-address, buyer-shipping-address, anonymous-address, billing-address, postal-area |
| API Commands | New Order Notification, Risk Information Notification, Merchant Calculation Callback |
| Content Format | String |
| Example | <country-code>US</country-code> |
| coupon-adjustment | |
| Definition | The <coupon-adjustment> tag contains information about a coupon that was applied to an order total. |
| Subtag of | merchant-codes |
| Subtags | code, calculated-amount?, applied-amount, message? |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <coupon-adjustment> |
| coupon-result | |
| Definition | The <coupon-result> tag contains information about a coupon used to calculate an order total. |
| Subtag of | merchant-code-results |
| Subtags | valid, calculated-amount, code, message |
| API Commands | Merchant Calculation Results |
| Content Format | Container |
| Example | <coupon-result> |
| cvn-response | |
| Definition | The <cvn-response> tag contains a credit verification value for the order. Possible values for this tag are: M - CVN match N - No CVN match U - CVN not available E - CVN error |
| Subtag of | risk-information, authorization-amount-notification |
| API Commands | Risk Information Notification, Authorization Amount Notification |
| Content Format | String |
| Example | <cvn-response>M</cvn-response> |
| date-time-zone | |
| Definition | The <date-time-zone> tag identifies the time zone that will be associated with the start-time and end-time 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-rule | |
| Definition | The <default-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 | default-tax-table |
| Subtags | shipping-taxed?, rate, tax-area?, tax-areas? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <default-tax-rule> |
| 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 |
|
||||||
| 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 |
|
||||||
| 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 |
|
||||||
| 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"> | ||||||
| digital-content | |
| Definition | The <digital-content> tag contains information relating to digital delivery of an item. |
| Subtag of | item |
| Subtags | description?, email-delivery?, key?, url?, display-disposition? |
| Content Format | Container |
| Example | <digital-content> |
| 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.
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> |
| Definition | The <email> tag identifies an email address that could be used to contact the person to be billed for an order or the order recipient. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification |
| Content Format | String |
| Example | <email>johnm@example.com</email> |
| email-allowed | |
| Definition | The <email-allowed> tag indicates whether the customer is willing to receive marketing emails from the merchant. |
| Subtag of | buyer-marketing-preferences |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | Boolean |
| Example | <email-allowed>true</email-allowed> |
| 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> |
| end-time | |
| Definition | Optional. The <end-time> tag identifies the time before which a notification must have been sent to be included in the API response. The time may not be within 30 minutes of the time that the API request is submitted. For example, if the <end-time> value is 2007-06-30T15:00:00, the API will return notifications sent any time between the start time and 2007-06-30T14:59:59. Note: The <end-time> value is exclusive, meaning the API response will include all notifications generated prior to, but not exactly at, the end time that you specify. In addition, if you specify an end time, you must also specify a start time. |
| Content Format | Date formatted as YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssTZD. |
| Example | <end-time>2008-05-19T15:06:26.051Z</end-time> <end-time>2008-05-19T17:06:26-02:00</end-time> |
| 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 |
|
||||||
| 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> |
| excluded-areas | |
| Definition | The <excluded-areas> tag identifies a list of regions where a shipping option is not available. |
| Subtag of | shipping-restrictions, address-filters |
| Subtags | us-state-area*, us-zip-area*, us-country-area*, postal-area* |
| API Commands | Checkout |
| Content Format | Container |
| Example | <excluded-areas> |
| fax | |
| Definition | The <fax> tag identifies a fax number that can be used to contact the person to be billed for an order or the order recipient. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this tag will contain an empty value. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <fax>800-555-1212</fax> |
| financial-order-state | |
| Definition | The <financial-order-state> tag identifies the financial status of an order. Valid values for this tag are: REVIEWING - Google Checkout is reviewing the order. CHARGEABLE - The order is ready to be charged. CHARGING - The order is being charged; you may not refund or cancel an order until is the charge is completed. CHARGED - The order has been successfully charged; if the order was only partially charged, the buyer's account page will reflect the partial charge. PAYMENT_DECLINED - The charge attempt failed. CANCELLED - Either the buyer or the seller canceled the order. An order's financial state cannot be changed after the order is canceled. Learn more about when an order may be canceled. CANCELLED_BY_GOOGLE - Google canceled the order. Google may cancel orders due to a failed charge without a replacement credit card being provided within a set period of time or due to a failed risk check. If Google cancels an order, you will be notified of the reason the order was canceled in the <reason> tag of an <order-state-change-notification>. Please see the Financial Commands in the Order Processing API document for more information about these states. |
| Subtag of | new-order-notification |
| API Commands | New Order Notification |
| Content Format | String |
| Example | <financial-order-state>REVIEWING</financial-order-state> |
| financial-state | |
| Definition | The <financial-state> tag identifies the financial status of an order. Valid values for this tag are: REVIEWING - Google Checkout is reviewing the order. CHARGEABLE - The order is ready to be charged. CHARGING - The order is being charged; you may not refund or cancel an order until is the charge is completed. CHARGED - The order has been successfully charged; if the order was only partially charged, the buyer's account page will reflect the partial charge. PAYMENT_DECLINED - The charge attempt failed. CANCELLED - The seller canceled the order; an order's financial state cannot be changed after the order is canceled. CANCELLED_BY_GOOGLE - Google canceled the order. Google may cancel orders due to a failed charge without a replacement credit card being provided within a set period of time or due to a failed risk check. If Google cancels an order, you will be notified of the reason the order was canceled in the <reason> tag of an <order-state-change-notification>. |
| Subtag of | order-list-request |
| API Commands | order report |
| Content Format | String |
| Example | <financial-state>CHARGED</financial-state> |
| first-name | |
| Definition | The <first-name> tag contains the first name of the buyer or recipient of an order. Please see the Matching Names in Notifications to Names in Your Database section for details about Google Checkout's name-splitting algorithm. |
| Subtag of | structured-name |
| Content Format | String |
| Example | <first-name>John</first-name |
| flat | |||||||
| Definition | The <flat> tag contains the flat fee amount that applies to a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | latest-charge-fee | ||||||
| API Commands | Charge Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <flat currency="USD">0.30</flat> | ||||||
| flat-rate-shipping | |||||||
| Definition | The <flat-rate-shipping> tag contains information about shipping costs that do not vary depending on the address to which the order is shipped. The <flat-rate-shipping> cost can be displayed before the buyer selects the shipping address. The <flat-rate-shipping> tag could also contain information about an offer for free shipping. |
||||||
| Attributes |
|
||||||
| Subtag of | shipping-methods | ||||||
| Subtags | price, shipping-restrictions | ||||||
| API Commands | Checkout | ||||||
| Content Format | Complex | ||||||
| Example | <flat-rate-shipping> | ||||||
| flat-rate-shipping-adjustment | |
| Definition | The <flat-rate-shipping-adjustment> tag contains shipping and handling costs for items that have flat-rate shipping costs. |
| Subtag of | shipping |
| Subtags | shipping-name, shipping-cost |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <flat-rate-shipping-adjustment> |
| fulfillment-order-state | |
| Definition | The <fulfillment-order-state> tag indicates the status of an order in the order handling process. Valid values for this tag are: NEW - The order has been received but not prepared for shipping. PROCESSING - The order is being prepared for shipping. DELIVERED - The seller has shipped the order. WILL_NOT_DELIVER - The seller will not ship the order; this status is used for canceled orders. |
| Subtag of | new-order-notification |
| API Commands | New Order Notification |
| Content Format | String |
| Example | <fulfillment-order-state>PROCESSING</fulfillment-order-state> |
| fulfillment-state | |
| Definition | The <fulfillment-state> tag indicates the status of an order in the order handling process. Valid values for this tag are: NEW - The order has been received but not prepared for shipping. PROCESSING - The order is being prepared for shipping. DELIVERED - The seller has shipped the order. WILL_NOT_DELIVER - The seller will not ship the order; this status is used for canceled orders. |
| Subtag of | order-list-request |
| API Commands | order report |
| Content Format | String |
| Example | <fulfillment-state>NEW</fulfillment-state> |
| gift-certificate-adjustment | |
| Definition | The <gift-certificate-adjustment> tag contains information about a gift certificate that was applied to an order total. |
| Subtag of | merchant-codes |
| Subtags | code, calculated-amount?, applied-amount, message? |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <gift-certificate-adjustment> |
| gift-certificate-result | |
| Definition | The <gift-certificate-result> tag contains information about a gift certificate used to calculate an order total. |
| Subtag of | merchant-code-results |
| Subtags | valid, calculated-amount, code, message |
| API Commands | Merchant Calculation Results |
| Content Format | Container |
| Example | <gift-certificate-result> |
| good-until-date | |
| Definition | The <good-until-date> tag identifies the date that the order in a Checkout API request expires. The date must be specified using the ISO 8601 Date and Time Format. The time must include the time-zone designator for UTC (Coordinated Universal Time), which is "Z", or you may specify a local time along with a time-zone offset in hours and minutes. A time zone offset of "+hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes ahead of UTC. A time zone offset of "-hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes behind UTC. The examples show dates formatted using the UTC time-zone designator and using time-zone offsets. Note: If you specify a value for this element, Google Checkout will reject the shopping cart if the user submits the cart after the specified date. |
| Subtag of | cart-expiration |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Date/Time |
| Example | <good-until-date>2008-01-01T04:59:59Z</good-until-date> <good-until-date>2007-12-31T11:59:59-05:00</good-until-date> |
| google-order-number | |
| Definition | The <google-order-number> tag contains an ID, which Google generates, that uniquely identifies an order. In a Notification History API request, when the <google-order-number> tag appears as a subtag of <order-numbers>, it specifies an order for which you are requesting notifications. When the tag appears as a subtag of <invalid-order-numbers> in a Notification History API response, it specifies an order that did not match one of your orders in the Checkout database even though you requested notifications for that order. |
| Subtag of | new-order-notification, order-state-change-notification, risk-information-notification, charge-amount-notification, refund-amount-notification, chargeback-amount-notification, authorization-amount-notification, order-numbers, invalid-order-numbers |
| API Commands | New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification |
| Content Format | String |
| Example | <google-order-number>6014423719</google-order-number> |
| height | ||||||||||
| Definition | The <height> tag contains information about the height of the package being shipped to the customer. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | shipping-package | |||||||||
| Content Format | Complex | |||||||||
| Example | <height unit="IN" value="6"/> | |||||||||
| hello | |
| Definition | The <hello> tag enables a simple test that verifies that your server communicates properly with Google Checkout. The fourth step of the Getting Started with Google Checkout section of the Developer's Guide explains how to execute this test. |
| Content Format | Container |
| Example | <hello/> |
| id | |
| Definition | The <id> tag specifies a value that uniquely identifies a Google Checkout promotion. |
| Subtag of | promotion |
| Content Format | String |
| Example | <id>4910</id> |
| input-xml | |
| Definition | The <input-xml> tag appears in diagnostic requests and contains the XML posted in your API request after that XML has been parsed by Google Checkout. Whatever XML that you send to Google will be encapsulated within the <input-xml> tag. Please see the Validating XML Messages to Google Checkout section for more information about diagnostic requests and responses. |
| Subtag of | diagnosis |
| API Commands | Synchronous Responses |
| Content Format | Container |
| Example | <input-xml> |
| invalid-order-numbers | |
| Definition | The <invalid-order-numbers> tag encapsulates a list of google order numbers for which you requested a notification history but that are not valid Google Checkout order numbers. |
| Content Format | Container |
| Example | <invalid-order-numbers> |
| ip-address | |
| Definition | The <ip-address> tag contains the buyer's IP address, which Google uses to assess the risk that the order is fraudulent. |
| Subtag of | risk-information |
| API Commands | Risk Information Notification |
| Content Format | String |
| Example | <ip-address>10.10.10.10</ip-address> |
| item | |
| Definition | The <item> tag contains information about an individual item listed in the customer's shopping cart. |
| Subtag of | items |
| Subtags | item-name, item-description, unit-price, quantity, item-weight?, merchant-item-id?, tax-table-selector?, digital-content?, merchant-private-item-data? |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <item> |
| item-description | |
| Definition | The <item-description> tag contains a description of an item. |
| Subtag of | item |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | String |
| Example | <item-description>Easy-to-use MP3 Player</item-description> |
| item-id | |
| Definition | The <item-id> tag contains one or more values that uniquely identify an item in an order. |
| Subtag of | item-ids, item-shipping-information |
| Subtags | merchant-item-id |
| Content Format | Container |
| Example | <item-id> |
| item-ids | |
| Definition | The <item-ids> tag encapsulates a list of items that you are marking as backordered, cancelled or returned. The <item-ids> tag may also specify a list of items for which you want to reset shipping information. |
| Subtag of | backorder-items, cancel-items, reset-items-shipping-information, return-items |
| Subtags | item-id* |
| Content Format | Container |
| Example | <item-ids> |
| item-name | |
| Definition | The <item-name> tag identifies the name of an item. |
| Subtag of | item |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | String |
| Example | <item-name>HelloWorld 2GB MP3 Player</item-name> |
| item-shipping-information | |
| Definition | The <item-shipping-information> tag encapsulates information about a shipped item. |
| Subtag of | item-shipping-information-list |
| Subtags | item-id, tracking-data-list? |
| Content Format | Container |
| Example | <item-shipping-information> |
| item-shipping-information-list | |
| Definition | The <item-shipping-information-list> tag contains a list of <item-shipping-information> elements, each of which identifies an item in an order and may also provide shipment tracking information for that item. |
| Subtag of | ship-items |
| Subtags | item-shipping-information* |
| Content Format | Container |
| Example | <item-shipping-information-list> |
| item-weight | ||||||||||
| Definition | The <item-weight> tag specifies the weight of an individual item in the customer's shopping cart. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | item | |||||||||
| Content Format | Complex | |||||||||
| Example | <item-weight unit="LB" value="5.5" /> | |||||||||
| items | |
| Definition | The <items> tag contains the list of items in the customer's shopping cart. |
| Subtag of | shopping-cart |
| Subtags | item* |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <items> |
| key | |
| Definition | The <key> tag contains a key needed to download or unlock a digital content item. |
| Subtag of | digital-content |
| Content Format | String |
| Example | <key>ad8x-15ss-gs9x-as91</key> |
| last-name | |
| Definition | The <last-name> tag contains the last name of the buyer or recipient of an order. Please see the Matching Names in Notifications to Names in Your Database section for details about Google Checkout's name-splitting algorithm. |
| Subtag of | structured-name |
| Content Format | String |
| Example | <last-name>Smith</last-name> |
| latest-charge-amount | |||||||
| Definition | The <latest-charge-amount> tag contains the amount most recently charged for a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | charge-amount-notification | ||||||
| API Commands | Charge Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-charge-amount currency="USD">50.00</latest-charge-amount> | ||||||
| latest-charge-fee | |
| Definition | The <latest-charge-fee> tag contains the flat rate fee and percentage fee rate as well as the total cost of the fee associated with this order. |
| Subtag of | charge-amount-notification |
| Subtags | percentage, flat, total |
| API Commands | Charge Amount Notification |
| Content Format | Container |
| Example | <latest-charge-fee> |
| latest-chargeback-amount | |||||||
| Definition | The <latest-chargeback-amount> tag contains the amount most recently charged back against a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | chargeback-amount-notification | ||||||
| API Commands | Chargeback Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-chargeback-amount currency="USD">50.00</latest-chargeback-amount> | ||||||
| latest-chargeback-fee-amount | |||||||
| Definition | The <latest-chargeback-fee-amount> tag contains the amount of the chargeback fee that applies to a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | chargeback-amount-notification | ||||||
| API Commands | Chargeback Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-chargeback-fee-amount currency="USD">10.00</latest-chargeback-fee-amount> | ||||||
| latest-fee-refund-amount | |||||||
| Definition | The <latest-fee-refund-amount> tag contains the amount of the transaction fee that has been refunded to the merchant for this order. |
||||||
| Attributes |
|
||||||
| Subtag of | chargeback-amount-notification, refund-amount-notification | ||||||
| API Commands | Chargeback Amount Notification, Refund Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-fee-refund-amount currency="USD">4.30</latest-fee-refund-amount> | ||||||
| latest-promotion-charge-amount | |||||||
| Definition | The <latest-promotion-charge-amount> tag indicates how much Google contributed to the latest charge amount as a part of an ongoing promotion. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a merchant charged the customer the full amount of a $100 order, then the <latest-charge-amount> value would be $100 and the <latest-promotion-charge-amount> would be $10. |
||||||
| Attributes |
|
||||||
| Subtag of | charge-amount-notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-promotion-charge-amount currency="USD">10.00</latest-promotion-charge-amount> | ||||||
| latest-promotion-chargeback-amount | |||||||
| Definition | The <latest-promotion-chargeback-amount> tag indicates that a portion of the latest chargeback amount was originally paid by Google as a part of a promotion and is therefore being recouped by Google rather than by the customer. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a buyer had completed a $100 order, then the buyer would have paid $90 and Google would have paid $10 of the order total. If the buyer then disputed the charge, then the <latest-chargeback-amount> value would be $100 and the <latest-promotion-chargeback-amount> would be $10. |
||||||
| Attributes |
|
||||||
| Subtag of | chargeback-amount-notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-promotion-chargeback-amount currency="USD">10.00</latest-promotion-chargeback-amount> | ||||||
| latest-promotion-refund-amount | |||||||
| Definition | The <latest-promotion-refund-amount> tag indicates that a portion of the latest refund amount was originally paid by Google as a part of a promotion and is therefore being refunded to Google rather than to the customer. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a merchant refunded the customer the full amount of a $100 order, then the <latest-refund-amount> value would be $100 and the <latest-promotion-refund-amount> would be $10. Accordingly, the buyer would receive a $90 refund ($100 - $10). |
||||||
| Attributes |
|
||||||
| Subtag of | refund-amount-notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-promotion-refund-amount currency="USD">10.00</latest-promotion-refund-amount> | ||||||
| latest-refund-amount | |||||||
| Definition | The <latest-refund-amount> tag contains the most recent refund amount for a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | refund-amount-notification | ||||||
| API Commands | Refund Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-refund-amount currency="USD">50.00</latest-refund-amount> | ||||||
| length | ||||||||||
| Definition | The <length> tag contains information about the length of the package being shipped to the customer. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | shipping-package | |||||||||
| Content Format | Complex | |||||||||
| Example | <length unit="IN" value="15"/> | |||||||||
| merchant-calculated-shipping | |||||||
| Definition | The <merchant-calculated-shipping> tag contains information about a shipping option in which Google Checkout communicates with the merchant after the shopping cart items are posted and the buyer has selected a shipping address. You may ignore this tag if you are not implementing the Merchant Calculations API, which allows merchants to use a custom process to determine taxes, shipping costs and discounts for an order after the customer has selected a shipping address. |
||||||
| Attributes |
|
||||||
| Subtag of | shipping-methods | ||||||
| Subtags | price, address-filters?, shipping-restrictions? | ||||||
| API Commands | Checkout | ||||||
| Content Format | Container | ||||||
| Example | <merchant-calculated-shipping name="FedEx 2-day"> | ||||||
| merchant-calculated-shipping-adjustment | |
| Definition | The <merchant-calculated-shipping-adjustment> tag contains shipping and handling costs that were calculated by the merchant using a custom process. |
| Subtag of | shipping |
| Subtags | shipping-name, shipping-cost |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <merchant-calculated-shipping-adjustment> |
| merchant-calculation-callback | |||||||
| Definition | The <merchant-calculation-callback> tag contains all information related to a request that Google Checkout sends to a merchant for custom calculations. |
||||||
| Attributes |
|
||||||
| Subtags | buyer-id?, buyer-language, calculate, shopping-cart | ||||||
| API Commands | Merchant Calculation Callback | ||||||
| Content Format | Container | ||||||
| Example | <merchant-calculation-callback> | ||||||
| merchant-calculation-results | |
| Definition | The <merchant-calculation-results> tag contains a response to a request for custom calculations. |
| Subtags | results |
| API Commands | Merchant Calculation Results |
| Content Format | Container |
| Example | <merchant-calculation-results> |
| merchant-calculation-successful | |
| Definition | The <merchant-calculation-successful> tag indicates whether Google Checkout successfully received a <merchant-calculation-results> response from your Merchant Calculations URL. |
| Subtag of | new-order-notification |
| API Commands | New Order Notification |
| Content Format | Boolean |
| Example | <merchant-calculation-successful>true</merchant-calculation-successful> |
| merchant-calculations | |
| Definition | The <merchant-calculations> tag contains information about calculations that will be performed by the merchant. |
| Subtag of | merchant-checkout-flow-support |
| Subtags | merchant-calculations-url, accept-merchant-coupons?, accept-gift-certificates? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <merchant-calculations> |
| merchant-calculations-url | |
| Definition | The <merchant-calculations-url> tag identifies the URL to which Google Checkout should send <merchant-calculation-callback> requests. Merchants only need to include this tag in Checkout API requests if they have implemented the Merchant Calculations API. Note: Your production calculation service must use port 443, which is the default port for HTTPS. You can use either port 443 or port 80 for your callback URL in the Sandbox environment. |
| Subtag of | merchant-calculations |
| API Commands | Checkout |
| Content Format | String (URI) |
| Example | <merchant-calculations-url>http://www.example.com/custom.php</merchant-calculations-url> |
| merchant-checkout-flow-support | |
| Definition | The <merchant-checkout-flow-support> tag contains information about taxes, shipping and other custom calculations to be used in the checkout process. This tag also encapsulates URLs used during the checkout process, including URLs that allow the customer to edit a shopping cart before completing a purchase or to continue shopping after completing a purchase. |
| Subtag of | checkout-flow-support |
| Subtags | edit-cart-url?, continue-shopping-url?, tax-tables?, shipping-methods?, merchant-calculations?, request-buyer-phone-number?, platform-id?, analytics-data?, parameterized-urls? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <merchant-checkout-flow-support> |
| merchant-code-results | |
| Definition | The <merchant-code-results> tag contains information about coupons and gift certificates that were calculated into an order total. |
| Subtag of | result |
| Subtags | coupon-result*, gift-certificate-result* |
| API Commands | Merchant Calculation Results |
| Content Format | Container |
| Example | <merchant-code-results> |
| merchant-code-string | |||||||
| Definition | The <merchant-code-string> tag contains a coupon or gift certificate code that the customer entered for an order. |
||||||
| Attributes |
|
||||||
| Subtag of | merchant-code-strings | ||||||
| API Commands | Merchant Calculation Callback | ||||||
| Content Format | Container | ||||||
| Example | <merchant-code-string code="CodeXYZ"> | ||||||
| merchant-code-strings | |
| Definition | The <merchant-code-strings> tag encapsulates a list of coupon or gift certificate codes that a customer has entered for an order. |
| Subtag of | calculate |
| Subtags | merchant-code-string? |
| API Commands | Merchant Calculation Callback |
| Content Format | Container |
| Example | <merchant-code-strings> |
| merchant-codes | |
| Definition | The <merchant-codes> tag contains a list of gift certificate codes and coupon codes that were applied to an order total. |
| Subtag of | new-order-notification |
| Subtags | gift-certificate-adjustment*, coupon-adjustment* |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <merchant-codes> |
| merchant-item-id | |
| Definition | The <merchant-item-id> tag contains a value, such as a stock keeping unit (SKU), that you use to uniquely identify an item. Google Checkout will include this value in the merchant calculation callbacks and the new order notification for the order. This value also appears in the order information displayed in the Merchant Center. Note: To use the <merchant-item-id> to modify the shipping information for an item in an order, you must have provided the same <merchant-item-id> for that item in the Checkout API request for the order. |
| Subtag of | item, item-id |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | String |
| Example | <merchant-item-id>1234abcd</merchant-item-id> |
| merchant-order-number | |
| Definition | The <merchant-order-number> tag contains the order number that you have assigned to an order. This number appears in the reconciliation report available in the Merchant Center. |
| Subtag of | add-merchant-order-number |
| API Commands | Add Merchant Order Number |
| Content Format | String (Limit 255 characters) |
| Example | <merchant-order-number>1234abcd</merchant-order-number> |
| merchant-private-data | |
| Definition | The <merchant-private-data> tag contains any well-formed XML sequence that should accompany an order. Google Checkout will return this XML in the <merchant-calculation-callback> and the <new-order-notification> for the order. |
| Subtag of | shopping-cart |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <merchant-private-data> <merchant-note>my order number 76543</merchant-note> </merchant-private-data> |
| merchant-private-item-data | |
| Definition | The <merchant-private-item-data> tag contains any well-formed XML sequence that should accompany an individual item in an order. Google Checkout will return this XML in the <merchant-calculation-callback> and the <new-order-notification> for the order. |
| Subtag of | item |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <merchant-private-item-data> <item-data>Popular item - order more if needed</item-data> </merchant-private-item-data> |
| message | |
| Definition | The <message> tag contains a message associated with a coupon or gift certificate or, when used in a <send-buyer-message> request, a message that you want to communicate to a buyer about a specific order. The maximum accepted length for the tag value is 255 characters. |
| Subtag of | coupon-adjustment, gift-certificate-adjustment, coupon-result, gift-certificate-result, send-buyer-message |
| API Commands | New Order Notification, Send Buyer Message, Merchant Calculation Results |
| Content Format | String |
| Example | <message>You saved $10.00 with this gift certificate.</message> |
| method | |||||||
| Definition | The <method> tag identifies a shipping method for which costs need to be calculated. |
||||||
| Attributes |
|
||||||
| Subtag of | shipping | ||||||
| API Commands | Merchant Calculation Callback | ||||||
| Content Format | Complex | ||||||
| Example | <method name="FedEx"> | ||||||
| mode | |
| Definition | The <mode> tag specifies the method that will be used to round monetary values to two decimal places. This tag may contain any of the following values, each of which is defined in the Java 1.5 specification for the RoundingMode enumeration.RoundingMode enumeration.
|
| Subtag of | rounding-policy |
| API Commands | Checkout |
| Content Format | String |
| Example | <mode>HALF_UP</mode> |
| name | |
| Definition | The <name> tag identifies the name that Google uses to identify a promotion in the Merchant Center. |
| Subtag of | promotion |
| Content Format | String |
| Example | <name>Google 10 off 50</name> |
| new-financial-order-state | |
| Definition | The <new-financial-order-state> tag identifies the financial-order-state for an order following a status change. The <new-financial-order-state> tag is included in an order state change notification along with a previous-financial-order-state, which identifies the financial-order-state for the order prior to the status change. Please see the Financial Commands in the Order Processing API document or the financial-order-state element definition for a complete list of valid values for this tag. |
| Subtag of | order-state-change-notification |
| API Commands | Order State Change Notification |
| Content Format | String |
| Example | <new-financial-order-state>CHARGED</new-financial-order-state> |
| new-fulfillment-order-state | |
| Definition | The <new-fulfillment-order-state> tag identifies the fulfillment-order-state for an order following a status change. The <new-fulfillment-order-state> tag is included in an <order-state-change-notification> along with a previous-fulfillment-order-state, which identifies the fulfillment-order-state for the order prior to the status change. Please see the fulfillment-order-state element definition for a complete list of valid values for this tag. |
| Subtag of | order-state-change-notification |
| API Commands | Order State Change Notification |
| Content Format | String |
| Example | <new-fulfillment-order-state>PROCESSING</new-fulfillment-order-state> |
| new-order-notification | |||||||
| Definition | The <new-order-notification> tag contains information about a new order, including the billing address and shipping address associated with the order. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, buyer-billing-address, buyer-id, buyer-marketing-preferences, buyer-shipping-address, financial-order-state, fulfillment-order-state, google-order-number, order-adjustment, order-total, promotions?, shopping-cart, timestamp | ||||||
| API Commands | New Order Notification | ||||||
| Content Format | Container | ||||||
| Example | <new-order-notification xmlns="http://checkout.google.com/schema/2" serial-number="8571632143"> | ||||||
| next-page-token | |
| Definition | As a subtag of <notification-history-request>, the <next-page-token> tag contains a value that identifies the set of results that should be included in the API response. For example, the <next-page-token> tag might indicate that your application had already received the first 50 notifications queued up since the start time and that the response to the next request should therefore begin with the fifty-first notification sent after the start time. Note: If your API request specifies a next-page token, then it should not specify a start time, end time, google order numbers or notification types. The token is an encrypted value that includes any filtering criteria specified in the original API request associated with that token. As a subtag of <notification-history-response>, the <next-page-token> tag contains the token that you must submit in a subsequent notification-history-request to retrieve additional notifications matching your query parameters. Note that an API response will not include a <next-page-token> tag if either of the following conditions are true:
Note: The token can be up to 511 characters long and does not have a fixed length. As such, the length of the token may vary from one request to another. |
| Content Format | String |
| Example | <next-page-token>CPeFhvuBIxDxwp6Jn4w6GAI</next-page-token> |
| notification-acknowledgment | |||||||
| Definition | Your application must return an HTTP 200 response code when it receives and successfully processes a notification from Google Checkout. We recommend that, in the process of returning the HTTP 200 response code, your application return a <notification-acknowledgment> response, but this is not a required action. |
||||||
| Attributes |
|
||||||
| API Commands | Notification Acknowledgment | ||||||
| Content Format | Empty | ||||||
| Example | <notification-acknowledgment xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"/> | ||||||
| notification-history-request | |
| Definition | The <notification-history-request> command lets you retrieve a list of notifications from Google Checkout. You can request notifications for particular google order numbers or for a particular date range. In addition, you can also filter your response to only include particular types of notifications. |
| Subtags | next-page-token?, start-time?, end-time?, order-numbers?, notification-types? |
| Content Format | Container |
| Example | <notification-history-request> |
| notification-history-response | |||||||
| Definition | The <notification-history-response> tag contains a response to a notification history request. |
||||||
| Attributes |
|
||||||
| Content Format | Container | ||||||
| Example | <notification-history-response xmlns="http://checkout.google.com/schema/2" serial-number="8571632143"> | ||||||
| notification-type | |
| Definition | The <notification-type> tag identifies a type of notification that you would like returned in the API's notification history response. You may request more than one type of notification by adding one <notification-type> tag for each type of notification that you would like returned in the API response. If you do not specify a notification type, the API will return all notifications matching your request. The following list identifies valid values for this tag. Each value clearly maps to a notification defined in the Google Checkout Developer's Guide.
|
| Subtag of | notification-types |
| Content Format | String |
| Example | <notification-type>new-order</notification-type> |
| notification-types | |
| Definition | The <notification-types> tag encapsulates a list of <notification-type> tags, each of which identifies a type of notification that will be included in the API's notification history response. If you specify that only particular types of notifications should be included in the API response, then you must also specify either a start time and end time or a specific set of Google order numbers for which notifications should be returned. |
| Subtags | notification-type* |
| Content Format | Container |
| Example | <notification-types> |
| notifications | |
| Definition | The <notifications> tag encapsulates the list of notifications returned in the API response. |
| Subtags | authorization-amount-notification*, charge-amount-notification*, chargeback-amount-notification*, new-order-notification*, order-state-change-notification*, refund-amount-notification*, risk-information-notification* |
| Content Format | Container |
| Example | <notifications> |
| order-adjustment | |
| Definition | The <order-adjustment> tag contains information about adjustments to an order's total cost due to taxes, shipping, coupons and gift certificates. |
| Subtag of | new-order-notification |
| Subtags | adjustment-total?, merchant-calculation-successful?, merchant-codes?, shipping?, total-tax? |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <order-adjustment> |
| order-list-request | ||||||||||
| Definition | The <order-list-request> command lets you retrieve a report containing a list of Google Checkout orders. You must also specify a date range for the report, and you have the option of providing filters so that the report only includes orders with particular financial or fulfillment order states. Please note that order reports contain a maximum of 5000 orders. If your report contains that many orders, you may want to reduce the interval between the start and end dates for the report to ensure that all of your orders are included in the report. |
|||||||||
| Attributes |
|
|||||||||
| Subtags | financial-state, fulfillment-state, date-time-zone | |||||||||
| API Commands | order report | |||||||||
| Content Format | Complex | |||||||||
| Example | <order-list-request xmlns="http://checkout.google.com/schema/2" start-date="2007-09-01T00:00:00" end-date="2007-09-30T23:59:59"> | |||||||||
| order-numbers | |
| Definition | The <order-numbers> tag encapsulates a list of google order numbers for which you are requesting a notification history. You can specify up to 16 order numbers per request. The following list explains how the presence of the <order-numbers> tag affects the content of the API response:
|
| Subtags | google-order-number* |
| Content Format | Container |
| Example | <order-numbers> |
| order-processing-support | |
| Definition | The <order-processing-support> tag contains information about how Google should process an order or how Google should convey data about the order to the merchant. |
| Subtag of | checkout-shopping-cart |
| Subtags | request-initial-auth-details? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <order-processing-support> |
| order-state-change-notification | |||||||
| Definition | The <order-state-change-notification> tag contains information about an order that has an updated financial-order-state or fulfillment-order-state. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, new-fulfillment-order-state, new-financial-order-state, previous-financial-order-state, previous-fulfillment-order-state, reason?, timestamp | ||||||
| API Commands | Order State Change Notification | ||||||
| Content Format | Complex | ||||||
| Example | <order-state-change-notification xmlns="http://checkout.google.com/schema/2" serial-number="8571632143"> | ||||||
| order-total | |||||||
| Definition | The <order-total> tag contains the total cost of an order, including taxes and shipping costs as well as discounts from coupons and gift certificates. |
||||||
| Attributes |
|
||||||
| Subtag of | new-order-notification | ||||||
| API Commands | New Order Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <order-total currency="USD">321.98</order-total> | ||||||
| parameterized-url | |||||||
| Definition | The <parameterized-url> tag contains information about an individual web beacon that will be included on the Google Checkout order confirmation page. The <parameterized-url> tag has one required attribute, which identifies the base URL for the web beacon. This tag also has one optional subtag, which contains the list of dynamic variables that Google Checkout should add to the base URL. |
||||||
| Attributes |
|
||||||
| Subtag of | parameterized-urls | ||||||
| Subtags | parameters | ||||||
| Content Format | Complex | ||||||
| Example | <parameterized-url url="http://www.example.com/tracking?partnerID=123&partnerName=Bob's%20Big%20Store"> ... </parameterized-url> |
||||||
| parameterized-urls | |
| Definition | The <parameterized-urls> tag contains information about all of the web beacons that the merchant wants to add to the Google Checkout order confirmation page. This tag encapsulates a list of one or more <parameterized-url> tags. |
| Subtag of | merchant-checkout-flow-support |
| Subtags | parameterized-url* |
| Content Format | Container |
| Example | <parameterized-urls> |
| parameters | |
| Definition | The <parameters> tag encapsulates a list of URL parameters that will be added to the base URL for the web beacon. This tag has one subtag, <url-parameter>, which may appear multiple times. |
| Subtag of | parameterized-url |
| Subtags | url-parameter* |
| Content Format | Container |
| Example | <parameters> |
| partial-cc-number | |
| Definition | The <partial-cc-number> tag contains the last four digits of the buyer's credit card number. |
| Subtag of | risk-information |
| API Commands | Risk Information Notification |
| Content Format | String |
| Example | <partial-cc-number>1234</partial-cc-number> |
| percentage | |
| Definition | The <percentage> tag contains the percentage fee rate that applies to a particular order. |
| Subtag of | latest-charge-fee |
| API Commands | Charge Amount Notification |
| Content Format | Decimal |
| Example | <percentage>2.90</percentage> |
| phone | |
| Definition | The <phone> tag identifies a phone number that can be used to contact the person to be billed for an order or the order recipient. To receive either the phone number for the buyer or the order recipient, you must set a preference in your Google Checkout merchant account. To set this preference, log in to your merchant account and click the Settings tab. Then click the Integration link on the left side of the page. Expand the list of advanced settings and, depending on your preferences, check the box next to either or both of the following preferences:
Then click the Save button to update your settings. |
| Subtag of | buyer-billing-address, buyer-shipping-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification |
| Content Format | String |
| Example | <phone>800-555-1212</phone> |
| pickup | |||||||
| Definition | The <pickup> tag contains information about a shipping option in which neither a carrier nor a ship-to address is specified. If there is a handling charge for pickup, that cost may be included in this value. Note: If the customer chooses this shipping option, the new order notification that you receive for the order will not include a shipping address. |
||||||
| Attributes |
|
||||||
| Subtag of | shipping-methods | ||||||
| Subtags | price | ||||||
| API Commands | Checkout | ||||||
| Content Format | Container | ||||||
| Example | <pickup> | ||||||
| pickup-shipping-adjustment | |
| Definition | The <pickup-shipping-adjustment> tag contains shipping and handling costs for items that will be picked up by the buyer. |
| Subtag of | shipping |
| Subtags | shipping-name, shipping-cost |
| API Commands | New Order Notification |
| Content Format | Container |
| Example | <pickup-shipping-adjustment> |
| platform-id | |
| Definition | The <platform-id> tag should only be used by e-commerce providers who make API requests on behalf of a merchant. The tag's value contains a Google Checkout merchant ID that identifies the e-commerce provider. Note for e-commerce Providers: The Google Checkout Terms and Conditions require e-commerce providers that manage websites for merchants who are affiliated with Google Checkout to identify themselves. The value of the <platform-id> tag should be a Google Checkout Merchant ID that uniquely identifies the e-commerce provider. In keeping with this requirement, e-commerce providers should sign up for a Google Checkout merchant account. They should then use the merchant ID for that account as the <platform-id> tag value in Checkout API requests for all merchants using the provider's platform. However, providers should still use the merchant IDs and merchant keys assigned to the individual merchants to encode API requests from those merchants. |
| Subtag of | merchant-checkout-flow-support |
| API Commands | Checkout |
| Content Format | Long |
| Example | <platform-id>1234567890</platform-id> |
| postal-area | |
| Definition | The <postal-area> tag specifies a geographic region somewhere in the world. As a subtag of <allowed-areas>, the <postal-area> tag contains a country where a particular shipping option is available. The tag may also contain a postal code or range of postal codes in that country where the shipping option is offered. As a subtag of <excluded-areas>, the <postal-area> tag contains a country (and possibly a zip code or range of zip codes within that country) where a particular shipping option is unavailable. As a subtag of <tax-area> or <tax-areas>, the <postal-area> tag contains a country and possibly a zip code or range of zip codes where a tax rule should be applied. |
| Subtag of | allowed-areas, excluded-areas, tax-area, tax-areas |
| Subtags | country-code, postal-code-pattern? |
| API Commands | Checkout |
| Content Format | Complex |
| Example | <postal-area> |
| postal-code | |
| Definition | The <postal-code> tag identifies the zip code or postal code associated with either a billing address or a shipping address. |
| Subtag of | buyer-billing-address, buyer-shipping-address, anonymous-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification, Merchant Calculation Callback |
| Content Format | String |
| Example | <postal-code>94043</postal-code> |
| postal-code-pattern | |
| Definition | The <postal-code-pattern> tag contains a postal code or a range of postal codes for a specific country. To specify a range of postal codes, use an asterisk as a wildcard operator. For example, you can provide a <postal-code-pattern> value of SW* to indicate that a shipping option is available or a tax rule applies in any postal code beginning with the characters SW. |
| Subtag of | postal-area |
| API Commands | Checkout |
| Content Format | String |
| Example | <postal-code-pattern>94043</postal-code-pattern <postal-code-pattern>SW*</postal-code-pattern> |
| previous-financial-order-state | |
| Definition | The <previous-financial-order-state> tag identifies the financial-order-state for an order prior to a status change. The <previous-financial-order-state> tag is included in an <order-state-change-notification> along with a new-financial-order-state, which identifies the financial-order-state for the order following the status change. Please see the Financial Commands in the Order Processing API document or the financial-order-state element definition for a complete list of valid values for this tag. |
| Subtag of | order-state-change-notification |
| API Commands | Order State Change Notification |
| Content Format | String |
| Example | <previous-financial-order-state>CHARGING</previous-financial-order-state> |
| previous-fulfillment-order-state | |
| Definition | The <previous-fulfillment-order-state> tag identifies the fulfillment-order-state for an order prior to a status change. The <previous-fulfillment-order-state> tag is included in an order-state-change-notification along with a new-fulfillment-order-state, which identifies the fulfillment-order-state for the order following the status change. Please see the fulfillment-order-state element definition for a complete list of valid values for this tag. |
| Subtag of | order-state-change-notification |
| API Commands | Order State Change Notification |
| Content Format | String |
| Example | <previous-fulfillment-order-state>NEW</previous-fulfillment-order-state> |
| price | |||||||
| Definition | The <price> tag contains the cost to ship an order using a particular shipping method. This tag has one required attribute, which identifies the currency of the price. |
||||||
| Attributes |
|
||||||
| Subtag of | flat-rate-shipping, pickup, merchant-calculated-shipping | ||||||
| API Commands | Checkout | ||||||
| Content Format | Decimal | ||||||
| Example | <price currency="USD">8.54</price> | ||||||
| process-order | |||||||
| Definition | The <process-order> tag indicates that Google should update an order's fulfillment-order-state to PROCESSING. |
||||||
| Attributes |
|
||||||
| API Commands | Process Order | ||||||
| Content Format | Complex | ||||||
| Example | <process-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> | ||||||
| promotion | |
| Definition | The <promotion> tag contains information about a single promotion that was applied to the cost of an order. |
| Subtag of | promotions |
| Subtags | description?, id, name, total-amount |
| Content Format | Container |
| Example | <promotion> |
| promotions | |
| Definition | The <promotions> tag contains a list of promotions that were applied to the cost of an order. |
| Subtag of | new-order-notification |
| Subtags | promotion* |
| Content Format | Container |
| Example | <promotions> |
| quantity | |
| Definition | The <quantity> tag identifies how many units of a particular item are included in the customer's shopping cart. |
| Subtag of | item |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Integer |
| Example | <quantity>2</quantity> |
| rate | |
| Definition | The <rate> tag identifies a tax rate that is expressed as a multiplier. |
| Subtag of | default-tax-rule, alternate-tax-rule |
| API Commands | Checkout |
| Content Format | Double |
| Example | <rate>0.0825</rate> |
| reason | |
| Definition | As a subtag of <cancel-order> or <refund-order>, the <reason> tag contains the reason that you are canceling or refunding an order. As a subtag of <order-state-change-notification>, the <reason> tag, if provided, will contain a description of the reason that Google canceled a particular order. For example, Google would cancel an order if the buyer's credit card authorization failed and the buyer did not provide updated credit card information within seven days. This element may be included in an order-state-change notification when an order's financial state is changed to CANCELLED_BY_GOOGLE. Note: The maximum accepted length for the tag value is 140 characters. |
| Subtag of | cancel-order, cancel-items, order-state-change-notification, refund-order |
| API Commands | Order State Change Notification, Refund Order, Cancel Order |
| Content Format | String |
| Example | <reason>Failed risk check</reason> |
| redirect-url | |
| Definition | The <redirect-url> tag contains the URL to which a customer should be redirected when a merchant is using the server-to-server technique for submitting Checkout API requests. |
| Subtag of | checkout-redirect |
| API Commands | Checkout Redirect |
| Content Format | String |
| Example | <redirect-url>http://checkout.google.com/buy8572098456</redirect-url> |
| refund-amount-notification | |||||||
| Definition | The <refund-amount-notification> tag contains information about a refund that Google Checkout granted to a customer. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, latest-fee-refund-amount?,latest-refund-amount, latest-promotion-refund-amount?, total-refund-amount, timestamp | ||||||
| API Commands | Refund Amount Notification | ||||||
| Content Format | Container | ||||||
| Example | <refund-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| refund-order | |||||||
| Definition | The <refund-order> tag identifies an order that should be refunded. The <refund-order> tag may specify whether the buyer should be refunded the full amount of the order or a partial amount. |
||||||
| Attributes |
|
||||||
| Subtags | amount?, comment?, reason | ||||||
| API Commands | Refund Order | ||||||
| Content Format | Container | ||||||
| Example | <refund-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| region | |
| Definition | The <region> tag identifies the state or province associated with a billing address or shipping address. |
| Subtag of | buyer-billing-address, buyer-shipping-address, anonymous-address, billing-address |
| API Commands | New Order Notification, Risk Information Notification, Merchant Calculation Callback |
| Content Format | String |
| Example | <region>CA</region> |
| request-buyer-phone-number | |
| Definition | The <request-buyer-phone-number> tag indicates whether the customer must enter a phone number to complete an order. If this tag's value is true, the customer must enter a number, which Google Checkout will return in the new order notification for the order. |
| Subtag of | merchant-checkout-flow-support |
| API Commands | Checkout |
| Content Format | Boolean |
| Example | <request-buyer-phone-number>false</request-buyer-phone-number> |
| request-initial-auth-details | |
| Definition | The <request-initial-auth-details> tag indicates whether Google should send an <authorization-amount-notification> when a credit card is authorized for a new order. |
| Subtag of | order-processing-support |
| API Commands | Checkout |
| Content Format | Boolean |
| Example | <request-initial-auth-details>false</request-initial-auth-details> |
| request-received | |||||||
| Definition | The <request-received> tag confirms that Google received a properly formed request to change an order's status and that the merchant requested a valid status change. Note: This tag does not indicate that your request was successfully completed. |
||||||
| Attributes |
|
||||||
| API Commands | Synchronous Responses | ||||||
| Content Format | Empty | ||||||
| Example | <request-received xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"/> | ||||||
| reset-items-shipping-information | |||||||
| Definition | The <reset-items-shipping-information> command allows you to reset the shipping status for specific items in an order to "Not yet shipped". This command removes shipment tracking information for an item that has already been marked as shipped. It also removes any indication that the item has been backordered, cancelled or returned. |
||||||
| Attributes |
|
||||||
| Subtags | item-ids, send-email? | ||||||
| Content Format | Container | ||||||
| Example | <reset-items-shipping-information xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| result | ||||||||||
| Definition | The <result> tag contains calculations for taxes, shipping costs, and discounts for a particular shipping method and shipping address. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | results | |||||||||
| Subtags | total-tax?, shipping-rate?, shippable?, merchant-code-results? | |||||||||
| API Commands | Merchant Calculation Results | |||||||||
| Content Format | Complex | |||||||||
| Example | <result shipping-name="FedEx" address-id="938515801"> | |||||||||
| results | |
| Definition | The <results> tag contains one or more <result> elements, each of which contains shipping, tax and discount calculations for a particular shipping method and shipping address. |
| Subtag of | merchant-calculation-results |
| Subtags | result* |
| API Commands | Merchant Calculation Results |
| Content Format | Container |
| Example | <results> |
| return-items | |||||||
| Definition | The <return-items> command lets you specify that your customer returned one or more specific items in an order. |
||||||
| Attributes |
|
||||||
| Subtags | item-ids, send-email? | ||||||
| Content Format | Container | ||||||
| Example | <return-items xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| risk-information | |
| Definition | The <risk-information> tag contains information about the buyer that can be used to detect the risk, including the possibility of fraud, associated with an order. |
| Subtag of | risk-information-notification |
| Subtags | avs-response, billing-address, buyer-account-age, cvn-response, eligible-for-protection, ip-address, partial-cc-number |
| API Commands | Risk Information Notification |
| Content Format | Container |
| Example | <risk-information> |
| risk-information-notification | |||||||
| Definition | The <risk-information-notification> tag contains information that Google uses to ensure that an order is not fraudulent. The <risk-information-notification> tag is the root tag in a risk information notification. |
||||||
| Attributes |
|
||||||
| Subtags | google-order-number, risk-information, timestamp | ||||||
| API Commands | Risk Information Notification | ||||||
| Content Format | Container | ||||||
| Example | <risk-information-notification xmlns="http://checkout.google.com/schema/2" serial-number="8571632143"> | ||||||
| rounding-policy | |
| Definition | The <rounding-policy> tag contains information about the policy that will be used to round computed monetary values for an order. |
| Subtag of | merchant-checkout-flow-support |
| Subtags | mode, rule |
| API Commands | Checkout |
| Content Format | Container |
| Example | <rounding-policy> |
| rule | |
| Definition | The <rule> tag indicates when the rounding rule will be applied. Valid values for this tag are PER_LINE and TOTAL. For U.S. merchants, the default value for this tag is TOTAL. For U.K. merchants, the default value for this tag is PER_LINE. The following list explains the meaning of these two values:
|
| Subtag of | rounding-policy |
| API Commands | Checkout |
| Content Format | String |
| Example | <rule>PER_LINE</rule> |
| send-buyer-message | |||||||
| Definition | The <send-buyer-message> command instructs Google to send a message to a customer about a particular order. |
||||||
| Attributes |
|
||||||
| Subtags | send-email?, message | ||||||
| API Commands | Send Buyer Message | ||||||
| Content Format | Container | ||||||
| Example | <send-buyer-message xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| send-email | |
| Definition | The <send-email> tag indicates whether Google Checkout should email the buyer with updated information about the shipping status of the items in an order. Google's default behavior is to send an email. To prevent Google Checkout from sending this email, your command must include this element with a value of false. |
| Subtag of | deliver-order, send-buyer-message, backorder-items, cancel-items, reset-items-shipping-information, return-items, ship-items |
| API Commands | Deliver Order, Send Buyer Message |
| Content Format | Boolean |
| Example | <send-email>true</send-email> |
| ship-from | |||||||
| Definition | The <ship-from> tag contains information about the location from which an order will be shipped. |
||||||
| Attributes |
|
||||||
| Subtag of | shipping-package | ||||||
| Subtags | city, region, postal-code, country-code | ||||||
| Content Format | Container | ||||||
| Example | <ship-from id="Warehouse"> | ||||||
| ship-items | |||||||
| Definition | The <ship-items> command lets you specify that you have shipped one or more specific items in an order. You can also use the <ship-items> command to specify shipment tracking information for each shipped item. |
||||||
| Attributes |
|
||||||
| Subtags | item-shipping-information-list, send-email | ||||||
| Content Format | Container | ||||||
| Example | <ship-items xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| shippable | |
| Definition | The <shippable> tag indicates whether an order can be shipped to the specified shipping address. |
| Subtag of | result |
| API Commands | Merchant Calculation Results |
| Content Format | Boolean |
| Example | <shippable>true</shippable> |
| shipping | |
| Definition | The <shipping> tag contains information about the shipping method and costs associated with an order. When the <shipping> tag appears in a new order notification (as a subtag of <order-adjustment>), it has three possible subtags: <flat-rate-shipping-adjustment>, <merchant-calculated-shipping-adjustment> and <pickup-shipping-adjustment>. When the <shipping> tag appears in a merchant calculation callback (as a subtag of <calculate>), its only subtag is <method>, but that tag may occur multiple times. |
| Subtag of | order-adjustment, calculate |
| Subtags | carrier-calculated-shipping-adjustment?, flat-rate-shipping-adjustment?, merchant-calculated-shipping-adjustment?, pickup-shipping-adjustment?, method* |
| API Commands | Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <shipping> |
| shipping-company | |
| Definition | The <shipping-company> tag contains the name of the company that will ship the order. The only valid values for this tag are FedEx, UPS and USPS. |
| Subtag of | carrier-calculated-shipping-option |
| Content Format | String |
| Example | <shipping-company>UPS</shipping-company> |
| shipping-cost | |||||||
| Definition | The <shipping-cost> tag identifies the shipping and handling amount that has been added to an order total. |
||||||
| Attributes |
|
||||||
| Subtag of | merchant-calculated-shipping-adjustment, flat-rate-shipping-adjustment, pickup-shipping-adjustment | ||||||
| API Commands | New Order Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <shipping-cost>9.95</shipping-cost> | ||||||
| shipping-methods | |
| Definition | The <shipping-methods> tag contains information about the different ways that an order may be shipped. |
| Subtag of | merchant-checkout-flow-support |
| Subtags | carrier-calculated-shipping*, flat-rate-shipping*, merchant-calculated-shipping*, pickup* |
| API Commands | Checkout |
| Content Format | Container |
| Example | <shipping-methods> |
| shipping-name | |
| Definition | The <shipping-name> tag contains the name of the shipping method that the buyer selected for an order. |
| Subtag of | merchant-calculated-shipping-adjustment, flat-rate-shipping-adjustment, pickup-shipping-adjustment |
| API Commands | New Order Notification |
| Content Format | String |
| Example | <shipping-name>UPS</shipping-name> |
| shipping-package | |
| Definition | The <shipping-package> tag encapsulates information about an individual package that will be shipped to the buyer. |
| Subtag of | shipping-packages |
| Subtags | delivery-address-category?, height, length, ship-from, width |
| Content Format | Container |
| Example | <shipping-package> |
| shipping-packages | |
| Definition | The <shipping-packages> tag encapsulates information about all of the packages that will be shipped to the buyer. At this time, merchants may only specify one package per order. |
| Subtag of | carrier-calculated-shipping |
| Subtags | shipping-package |
| Content Format | Container |
| Example | <shipping-packages> |
| shipping-rate | |||||||
| Definition | The <shipping-rate> tag contains the shipping costs that have been calculated for an order. |
||||||
| Attributes |
|
||||||
| Subtag of | result | ||||||
| API Commands | Merchant Calculation Results | ||||||
| Content Format | Complex | ||||||
| Example | <shipping-rate currency="USD">14.50</shipping-rate> | ||||||
| shipping-restrictions | |
| Definition | The <shipping-restrictions> tag contains information about particular areas where items can (or cannot) be shipped. |
| Subtag of | flat-rate-shipping, merchant-calculated-shipping |
| Subtags | allowed-areas, excluded-areas?, allow-us-po-box? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <shipping-restrictions> |
| shipping-taxed | |
| Definition | The <shipping-taxed> tag indicates whether shipping charges for an order are taxable. |
| Subtag of | default-tax-rule |
| API Commands | Checkout |
| Content Format | Boolean |
| Example | <shipping-taxed>false</shipping-taxed> |
| shipping-type | |||||||
| Definition | The <shipping-type> tag identifies the shipping option that is being offered to the buyer. The table below shows the valid values for this tag for each carrier. None of these shipping options are for international shipping. Please note that Google will reject a Checkout API request that specifies a carrier-calculated shipping option for which the <shipping-type> is not valid for the specified carrier.
|
||||||
| Subtag of | carrier-calculated-shipping-option | ||||||
| Content Format | String | ||||||
| Example | <shipping-type>Priority Overnight</shipping-type> | ||||||
| shopping-cart | |
| Definition | The <shopping-cart> tag contains the list of items in a customer order and some other basic order information. |
| Subtag of | checkout-shopping-cart, new-order-notification, merchant-calculation-callback |
| Subtags | cart-expiration?, items, merchant-private-data? |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | Container |
| Example | <shopping-cart> |
| start-time | |
| Definition | Optional. The <start-time> tag identifies the earliest time that a notification could have been sent to be included in the API response. The time may not be within 30 minutes of the time that the API request is submitted or more than 450 days earlier than the time that the API request is submitted. Note: If you specify a start time, you must also specify an end time. |
| Content Format | Date formatted as YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssTZD. |
| Example | <start-time>2008-05-10T15:06:26</start-time> <start-time>2008-05-10T17:06:26-02:00</start-time> |
| state | |
| Definition | The <state> tag identifies a state where a particular tax rule is applied or where a particular shipping option is available or unavailable. |
| Subtag of | us-state-area |
| API Commands | Checkout |
| Content Format | String |
| Example | <state>CA</state> |
| string | |
| Definition | The <string> tag contains a description of a warning generated by an API request. |
| Subtag of | warnings, warning-messages |
| API Commands | Synchronous Responses |
| Content Format | String |
| Example | <string>Sample warning message here</string> |
| structured-name | |
| Definition | The <structured-name> tag contains the first name and last name of the buyer or recipient of an order. To receive first and last names in notifications, you must set a preference in your Google Checkout merchant account. To set this preference, log in to your merchant account and click the Settings tab. Then click the Integration link on the left side of the page. Expand the list of advanced settings and check the box next to the setting that says, "Provide the first name, last name and full name of the buyer and order recipient in separate fields in the new order notification." Then click the Save button to update your settings. |
| Subtag of | buyer-shipping-address, buyer-billing-address |
| Subtags | first-name, last-name |
| Content Format | Container |
| Example | <structured-name> |
| tax | |
| Definition | The <tax> tag indicates whether the merchant needs to calculate taxes for the order. |
| Subtag of | result |
| API Commands | Merchant Calculation Callback |
| Content Format | Boolean |
| Example | <tax>true</tax> |
| tax-area | |
| Definition | The <tax-area> tag contains information about a region, such as a state, zip code or country, where a tax rule should be applied. The <tax-areas> tag serves the same purpose as the <tax-area> tag but can identify one or more areas where a single tax rate applies. |
| Subtag of | default-tax-rule, alternate-tax-rule |
| Subtags | world-area?, postal-area?, us-country-area?, us-state-area?, us-zip-area? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <tax-area> |
| tax-areas | |
| Definition | The <tax-areas> tag contains one or more geographic areas where a tax rule should be applied. |
| Subtag of | default-tax-rule, alternate-tax-rule |
| Subtags | world-area?, postal-area?, us-country-area?, us-state-area?, us-zip-area? |
| API Commands | Checkout |
| Content Format | Container |
| Example | <tax-areas> |
| tax-rules | |
| Definition | The <tax-rules> tag contains information about the taxes applied in particular regions, such as states, zip codes or countries. The <tax-rules> tag contains a list of one or more <default-tax-rule> elements. |
| Subtag of | default-tax-table |
| Subtags | default-tax-rule* |
| API Commands | Checkout |
| Content Format | Container |
| Example | <tax-rules> |
| tax-table-selector | |
| Definition | The <tax-table-selector> tag identifies an alternate tax table that should be used to calculate tax for a particular item. The value of the <tax-table-selector> tag should correspond to the value of the name attribute of an alternate-tax-table. |
| Subtag of | item |
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification |
| Content Format | String |
| Example | <tax-table-selector>Ventura County</tax-table-selector> |
| tax-tables | |||||||
| Definition | The <tax-tables> tag contains information about all of the different rules that may be applied to calculate tax for an order. |
||||||
| Attributes |
|
||||||
| Subtag of | merchant-checkout-flow-support | ||||||
| Subtags | default-tax-table, alternate-tax-tables? | ||||||
| API Commands | Checkout | ||||||
| Content Format | Container | ||||||
| Example | <tax-tables> | ||||||
| timestamp | |
| Definition | The <timestamp> tag contains a date and time in ISO 8601 format. |
| Subtag of | new-order-notification, order-state-change-notification, risk-information-notification, charge-amount-notification, refund-amount-notification, chargeback-amount-notification, authorization-amount-notification |
| API Commands | New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification |
| Content Format | Date |
| Example | <timestamp>2007-03-19T15:06:26.051Z</timestamp> |
| total | |||||||
| Definition | The <total> tag contains the total fee amount that applies to a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | latest-charge-fee | ||||||
| API Commands | Charge Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <total currency="USD">4.60</flat> | ||||||
| total-amount | |||||||
| Definition | The <total-amount> tag specifies the amount that Google contributed to the cost of an order as a part of an ongoing promotion. |
||||||
| Attributes |
|
||||||
| Subtag of | promotion | ||||||
| Content Format | Decimal | ||||||
| Example | <total-amount currency="USD">10.00</total-amount> | ||||||
| total-charge-amount | |||||||
| Definition | The <total-charge-amount> tag contains the total amount charged for a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | charge-amount-notification | ||||||
| API Commands | Charge Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <total-charge-amount currency="USD">99.99</total-charge-amount> | ||||||
| total-chargeback-amount | |||||||
| Definition | The <total-chargeback-amount> tag contains the total amount charged back against a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | chargeback-amount-notification | ||||||
| API Commands | Chargeback Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <total-chargeback-amount currency="USD">99.99</total-chargeback-amount> | ||||||
| total-refund-amount | |||||||
| Definition | The <total-refund-amount> tag contains the total refund amount for a particular order. |
||||||
| Attributes |
|
||||||
| Subtag of | refund-amount-notification | ||||||
| API Commands | Refund Amount Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <total-refund-amount currency="USD">99.99</total-refund-amount> | ||||||
| total-tax | |||||||
| Definition | The <total-tax> tag contains the total tax amount for an order. |
||||||
| Attributes |
|
||||||
| Subtag of | order-adjustment, result | ||||||
| API Commands | New Order Notification, Merchant Calculation Results | ||||||
| Content Format | Decimal | ||||||
| Example | <total-tax currency="USD">11.05</total-tax> | ||||||
| tracking-data | |
| Definition | The <tracking-data> tag contains information used to track a package through the carrier. |
| Subtag of | add-tracking-data, deliver-order, tracking-data-list |
| Subtags | carrier, tracking-number |
| API Commands | Add Tracking Data, Deliver Order |
| Content Format | Container |
| Example | <tracking-data> |
| tracking-data-list | |
| Definition | The <tracking-data-list> tag contains a list of <tracking-data> elements, each of which contains shipment tracking information for an item. |
| Subtag of | item-shipping-information |
| Subtags | tracking-data* |
| Content Format | Container |
| Example | <tracking-data-list> |
| tracking-number | |
| Definition | The <tracking-number> tag contains the shipper's tracking number that is associated with an order. |
| Subtag of | tracking-data |
| API Commands | Add Tracking Data, Deliver Order |
| Content Format | String |
| Example | <tracking-number>Z5498W45987123684</tracking-number> |
| unarchive-order | |||||||
| Definition | The <unarchive-order> tag indicates a request to unarchive a particular order. You would use this command to return an order to your Merchant Center Inbox after the order had previously been archived. |
||||||
| Attributes |
|
||||||
| API Commands | Unarchive Order | ||||||
| Content Format | Complex | ||||||
| Example | <unarchive-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> | ||||||
| unit-price | |||||||
| Definition | The <unit-price> tag identifies the cost of the item. This tag has one required attribute, which identifies the currency of the price. |
||||||
| Attributes |
|
||||||
| Subtag of | item | ||||||
| API Commands | Checkout, Merchant Calculation Callback, New Order Notification | ||||||
| Content Format | Decimal | ||||||
| Example | <unit-price currency="USD">159.99</unit-price> | ||||||
| url | |
| Definition | The <url> tag contains a URI from which the customer can download the purchased content. |
| Subtag of | digital-content |
| Content Format | String |
| Example | <url>http://download.example.com/key/124194</url> |
| url-parameter | ||||||||||
| Definition | The <url-parameter> tag contains information about an individual parameter that will be added to the base URL for a web beacon. The <url-parameter> tag has two required attributes: the parameter key and the parameter value that Google should include in the web beacon URL. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | parameters | |||||||||
| Content Format | Complex | |||||||||
| Example | <url-parameter name="taxes" type="tax-amount"> | |||||||||
| us-country-area | |||||||
| Definition | As a subtag of <allowed-areas>, the <us-country-area> tag identifies a region of the United States where a particular shipping option is available. As a subtag of <excluded-areas>, the <us-country-area> tag identifies a region of the United States where a particular shipping option is unavailable. As a subtag of <tax-area> or <tax-areas>, the <us-country-area> tag identifies a region of the United States where a tax rule should be applied. This tag has one required attribute, which identifies the region of the United States. |
||||||
| Attributes |
|
||||||
| Subtag of | allowed-areas, excluded-areas, tax-area, tax-areas | ||||||
| API Commands | Checkout | ||||||
| Content Format | Complex | ||||||
| Example | <us-country-area country-area="CONTINENTAL_48"/> | ||||||
| us-state-area | |
| Definition | As a subtag of <allowed-areas>, the <us-state-area> tag contains a state where a particular shipping option is available. As a subtag of <excluded-areas>, the <us-state-area> tag contains a state where a particular shipping option is unavailable. As a subtag of <tax-area> or <tax-areas>, the <us-state-area> tag contains a state where a tax rule should be applied. |
| Subtag of | allowed-areas, excluded-areas, tax-area, tax-areas |
| Subtags | state |
| API Commands | Checkout |
| Content Format | Container |
| Example | <us-state-area> |
| us-zip-area | |
| Definition | As a subtag of <allowed-areas>, the <us-zip-area> tag contains a zip code or range of zip codes where a particular shipping option is available. As a subtag of <excluded-areas>, the <us-zip-area> tag contains a zip code or range of zip codes where a particular shipping option is unavailable. As a subtag of <tax-area> or <tax-areas>, the <us-zip-area> tag contains a zip code or range of zip codes where a tax rule should be applied. |
| Subtag of | allowed-areas, excluded-areas, tax-area, tax-areas |
| Subtags | zip-pattern |
| API Commands | Checkout |
| Content Format | Container |
| Example | <us-zip-area> |
| valid | |
| Definition | The <valid> tag indicates whether a coupon or gift certificate code that was submitted by the customer is actually valid. |
| Subtag of | coupon-result, gift-certificate-result |
| API Commands | Merchant Calculation Results |
| Content Format | Boolean |
| Example | <valid>true</valid> |
| warning-messages | |
| Definition | The <warning-messages> tag contains a list of warning messages generated during Google Checkout's handling of your API request. This element is only included if your API request generated warnings. |
| Subtag of | error |
| Subtags | string* |
| API Commands | Synchronous Responses |
| Content Format | Container |
| Example | <warning-messages> |
| warnings | |
| Definition | The <warnings> tag contains a list of warning messages generated during Google Checkout's diagnosis of your API request. This element is only included if your API request generated warnings. Please see the Validating XML Messages to Google Checkout section for more information about diagnostic requests and responses. |
| Subtag of | diagnosis |
| Subtags | string* |
| API Commands | Synchronous Responses |
| Content Format | Container |
| Example | <warnings> |
| width | ||||||||||
| Definition | The <width> tag contains information about the width of the package being shipped to the customer. |
|||||||||
| Attributes |
|
|||||||||
| Subtag of | shipping-package | |||||||||
| Content Format | Complex | |||||||||
| Example | <width unit="IN" value="24"/> | |||||||||
| world-area | |
| Definition | The <world-area> tag represents the entire world. This tag indicates that a shipping option is available worldwide or that a particular tax rule applies worldwide. For shipping options, the <world-area> tag can only appear as a subtag of the allowed-areas tag. (Including the <world-area> tag as a subtag of the excluded-areas tag would make the corresponding shipping option unavailable to all shipping addresses.) However, you can use the <world-area> tag to indicate that a shipping option is available worldwide and then identify specific excluded areas where the shipping option is unavailable. Those excluded areas could identify regions that are covered by other shipping options or regions where you do not ship items. For tax rules, Google Checkout will select the first tax rule that matches the customer's shipping address. As such, if you use the <world-area> tag to define the area where a tax rule applies, that tax rule must appear last in the list of tax rules in your API request. See the XML Examples for Tax Areas to see a feed excerpt that uses the <world-area> tag for tax rules. |
| Subtag of | allowed-areas, tax-area, tax-areas |
| API Commands | Checkout |
| Content Format | Complex |
| Example | <world-area/> |
| zip-pattern | |
| Definition | The <zip-pattern> tag contains a zip code or a range of zip codes. To specify a range of zip codes, use an asterisk as a wildcard operator. For example, you can specify that a shipping option is available or a tax rule applies to zip codes 94040 through 94049 by entering 9404* as the <zip-pattern> value. |
| Subtag of | us-zip-area |
| API Commands | Checkout |
| Content Format | String |
| Example | <zip-pattern>94043</zip-pattern <zip-pattern>9404*</zip-pattern> |