| 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 Guide for Nonprofit Organizations. This list includes the XML tags and attributes used in the Checkout API, the Notification API and the Order Processing API.
Please note that this list only defines tags that are relevant to allowing donors to submit donations to your organization through Google Checkout. Some of the tags in this list may reference other tags that are intended for merchants who are selling items through Google Checkout.
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 | I | L | M | N | O | P | R | S | T | U | W |
| 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 | ||||||
| Content Format | Container | ||||||
| Example | <add-merchant-order-number xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| 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 |
| 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 |
| Content Format | String |
| Example | <address2>Building 41</address2> |
| 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 | ||||||
| Content Format | Currency | ||||||
| Example | <amount currency="USD">129.43</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 |
|
||||||
| Content Format | Empty | ||||||
| Example | <archive-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/> | ||||||
| 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 | ||||||
| Content Format | Container | ||||||
| Example | <authorization-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| 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 |
| 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 |
| Content Format | Long |
| Example | <buyer-id>294873009217523</buyer-id> |
| 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 |
| 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 |
| Content Format | Complex |
| Example | <buyer-shipping-address> |
| 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 | ||||||
| Content Format | Container | ||||||
| Example | <cancel-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"> | ||||||
| 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 | ||||||
| Content Format | Container | ||||||
| Example | <charge-amount-notification xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"> | ||||||
| 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 | ||||||
| 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 |
| 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 | ||||||
| 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 |
| 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 |
| Content Format | String |
| Example | <city>Mountain View</city> |
| 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 |
| 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 |
| Content Format | String |
| Example | <company-name>GiftCert12345</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 |
| 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 |
| 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 areashipping restriction or address filter. 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 |
| Content Format | String |
| Example | <country-code>US</country-code> |
| 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 |
|
||||||
| 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? | ||||||
| Content Format | Container | ||||||
| Example | <diagnosis xmlns="http://checkout.google.com/schema/2" serial-number="3c394432-8270-411b-9239-98c2c499f87f"> | ||||||
| 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 |
| Content Format | String (URL) |
| Example | <edit-cart-url> http://www.example.com/shopping.edit.php </edit-cart-url> |
| 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 |
| 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 |
| Content Format | Boolean |
| Example | <email-allowed>true</email-allowed> |
| 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? | ||||||
| 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 |
| Content Format | Container |
| Example | <error-message>Error: Illegal Argument</error-message> |
| 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 |
| 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 - 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>. Please see the Financial Commands in the Order Processing API document for more information about these states. |
| Subtag of | new-order-notification |
| Content Format | Complex? |
| Example | <financial-order-state>REVIEWING</financial-order-state> |
| first-name | |
| Definition | The <first-name> tag contains the first name of the buyer or recipient of an order. Please see the Name Parsing 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> | ||||||
| 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 |
| Content Format | String |
| Example | <fulfillment-order-state>PROCESSING</fulfillment-order-state> |
| google-order-number | |
| Definition | The <google-order-number> tag contains an ID, which Google generates, that uniquely identifies an 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 |
| Content Format | String |
| Example | <google-order-number>6014423719</google-order-number> |
| id | |
| Definition | The <id> tag specifies a value that uniquely identifies a Google Checkout promotion. |
| Subtag of | promotion |
| Content Format | String |
| Example | <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 |
| Content Format | Container |
| Example | <input-xml> |
| 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, merchant-item-id?, tax-table-selector?, digital-content?, merchant-private-item-data? |
| Content Format | Container |
| Example | <item> |
| item-description | |
| Definition | The <item-description> tag contains a description of an item. |
| Subtag of | item |
| Content Format | String |
| Example | <item-description>Easy-to-use MP3 Player</item-description> |
| item-name | |
| Definition | The <item-name> tag identifies the name of an item. |
| Subtag of | item |
| Content Format | String |
| Example | <item-name>HelloWorld 2GB MP3 Player</item-name> |
| items | |
| Definition | The <items> tag contains the list of items in the customer's shopping cart. |
| Subtag of | shopping-cart |
| Subtags | item* |
| Content Format | Container |
| Example | <items> |
| last-name | |
| Definition | The <last-name> tag contains the last name of the buyer or recipient of an order. Please see the Name Parsing 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 | ||||||
| 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 | ||||||
| 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-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 | ||||||
| Content Format | Decimal | ||||||
| Example | <latest-refund-amount currency="USD">50.00</latest-refund-amount> | ||||||
| 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? |
| Content Format | Container |
| Example | <merchant-checkout-flow-support> |
| 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 |
| 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 |
| Content Format | String (Limit 255 characters) |
| Example | <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 |
| 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 |
| 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. Note: 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 |
| Content Format | String |
| Example | <message>You saved $10.00 with this gift certificate.</message> |
| 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> |
| 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 |
| 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 |
| 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 | ||||||
| Content Format | Container | ||||||
| Example | <new-order-notification xmlns="http://checkout.google.com/schema/2" serial-number="8571632143"> | ||||||
| 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. |
| Content Format | Empty |
| Example | <notification-acknowledgment xmlns="http://checkout.google.com/schema/2"/> |
| 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 | ||||||
| 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 | ||||||
| Content Format | Decimal | ||||||
| Example | <order-total currency="USD">321.98</order-total> | ||||||
| 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 |
| Content Format | String |
| Example | <phone>800-555-1212</phone> |
| 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 |
| Content Format | String |
| Example | <postal-code>94043</postal-code> |
| 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 |
| 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 |
| Content Format | String |
| Example | <previous-fulfillment-order-state>NEW</previous-fulfillment-order-state> |
| 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> |
| 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 168 hours (7 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 |
| 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 |
| 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 | ||||||
| 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 | ||||||
| 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 |
| 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 |
| Content Format | Boolean |
| Example | <request-buyer-phone-number>false</request-buyer-phone-number> |
| 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 |
|
||||||
| Content Format | Empty | ||||||
| Example | <request-received xmlns="http://checkout.google.com/schema/2" serial-number="dc66f8c7"/> | ||||||
| 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 | ||||||
| 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 |
| Content Format | Boolean |
| Example | <send-email>true</send-email> |
| 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? |
| Content Format | Container |
| Example | <shopping-cart> |
| string | |
| Definition | The <string> tag contains a description of a warning generated by an API request. |
| Subtag of | warnings, warning-messages |
| 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> |
| 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 |
| 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 | ||||||
| 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 | ||||||
| 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 | ||||||
| Content Format | Decimal | ||||||
| Example | <total-refund-amount currency="USD">99.99</total-refund-amount> | ||||||
| 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 |
|
||||||
| 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 | ||||||
| Content Format | Currency | ||||||
| Example | <unit-price currency="USD">159.99</unit-price> | ||||||
| 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* |
| 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* |
| Content Format | Container |
| Example | <warnings> |