| Note: This is the latest documentation. The previous version of this page is identical — only the left nav differs. |
Google Checkout allows you to define shipping options for pickup using the <pickup> tag. For this type of shipping method, your customer picks the item up from your business. The customer does not need to specify a shipping address for this type of shipping.
This document explains how to include pickup shipping options in a Checkout API request. It also provides two XML examples for pickup shipping, including an example that combines an option for pickup with a flat-rate shipping option for home delivery.
Note: Orders for which the buyer has selected pickup shipping are not covered by Google Checkout's payment guarantee. In addition, you cannot combine pickup shipping options with merchant-calculated shipping options. However, you can combine pickup shipping options with other types of shipping options.
The following checklist will help you to ensure that you have correctly implemented shipping options for pickup at your business:
Checkout API requests may not include two or more shipping methods that have the same name. As such, you must specify a unique name for each shipping method that you offer. Shipping method names are contained in the name attribute value of the <pickup>, <flat-rate-shipping> and <merchant-calculated-shipping> tags. To verify that all names are unique, Google Checkout trims whitespace characters from the beginning and the end of the name string. Google Checkout then does a case-insensitive comparison of the names to ensure that they are unique. For example, Google Checkout would consider all of these names to be identical:
|
Regular shipping
REGULAR SHIPPING
Regular shipping
ReGuLaR sHiPPing
Ensure that your Checkout API request does not contain both pickup shipping options and merchant-calculated shipping options.
The XML examples below demonstrate several use cases for implementing pickup shipping. Please note that the examples only include the XML within the <shipping-methods> tag.
The following example shows a shipping method for pickup.
<shipping-methods>
<pickup name="Pickup">
<price currency="USD">0.00</price>
</pickup>
</shipping-methods>
This example demonstrates how you could offer shipping options for pickup and delivery. The example includes a flat-rate shipping option for delivery. The delivery option also uses shipping restrictions to specify that delivery is only available in two zip codes in Manhattan's Upper East Side neighborhood. You could charge a fee for delivery by setting the value of the <price> tag to the delivery fee amount.
<shipping-methods>
<flat-rate-shipping name="Delivery">
<price currency="USD">0.00</price>
<shipping-restrictions>
<allowed-areas>
<us-zip-area>
<zip-pattern>10021</zip-pattern>
</us-zip-area>
<us-zip-area>
<zip-pattern>10022</zip-pattern>
</us-zip-area>
</allowed-areas>
<allow-us-po-box>false</allow-us-po-box>
</shipping-restrictions>
</flat-rate-shipping>
<pickup name="Pickup">
<price currency="USD">0.00</price>
</pickup>
</shipping-methods>
Certain symbols may be displayed next to some subtags in the definitions below. These symbols, and their meanings, are:
| 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> | ||||||
| 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> | ||||||
| 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> |