Google Checkout APIs

Documentation

Developer Tools

Support Resources

Google Checkout HTML API - Pickup Shipping

Overview
Checklist for Launching Pickup Shipping
HTML Examples for Pickup Shipping

Example 1 – Pickup
Example 2 – Offering Pickup or Delivery

Overview

Google Checkout allows you to define shipping options for which 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 HTML examples for pickup shipping, including an example that combines an option for pickup with a flat-rate shipping option for home delivery.

Checklist for Launching Pickup Shipping

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 specified using the name parameter. 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
```

HTML Examples for Pickup Shipping

The HTML examples below demonstrate several use cases for implementing pickup shipping. Please note that the examples only include the input parameters used for pickup shipping.

Example 1 – Pickup

The following example shows a shipping method for pickup.

<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.name"
  value="Pickup"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.price"
  value="0.00"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.price.currency"
  value="USD"/>

Example 2 – Offering Pickup or Delivery

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 parameter to the delivery fee amount.

<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.name"
  value="Delivery"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.price"
  value="0.00"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.currency"
  value="USD"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.shipping-restrictions.allowed-areas.us-zip-area-1.zip-pattern"
  value="10021"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.shipping-restrictions.allowed-areas.us-zip-area-2.zip-pattern"
  value="10022"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.flat-rate-shipping-1.shipping-restrictions.allowed-areas.allow-us-po-box"
  value="false"/>

<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.name"
  value="Pickup"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.price"
  value="0.00"/>
<input type="hidden"
  name="checkout-flow-support.merchant-checkout-flow-support.shipping-methods.pickup-1.price.currency"
  value="USD"/>

HTML Parameter Definitions

currency

The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.

Associated recurring elements

The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.

API commands

Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification

Content format for parameter value

String

Sample use(s)

In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99"
item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD"

In a new order notification:
order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD

In a refund order request:
amount=12.99&amount.currency=USD

name

In a Checkout API request, the name parameter value contains a string that can be used to identify a tax table or shipping method. The parameter value must be at least one non-space character and may not be longer than 255 characters. The name parameter can also be used in a Checkout API request to identify the name of a query string parameter that will be included in a web beacon URL for third-party conversion tracking. The parameter's value is the name that the third-party tracking provider uses in its web beacon URLs.

In a new order notification, the name parameter specifies the name that Google uses to identify a promotion in the Merchant Center.

Associated recurring elements

When the name parameter specifies the name of a query string parameter that will be included in a web beacon URL for third-party conversion tracking, the parameterized-url element must be numbered to associate the URL with a particular web beacon. In addition, the url-parameter element must be numbered so that the parameter name may be associated with the parameter value, which is expressed using the type parameter. When the name parameter is associated with an alternate tax table, the alternate-tax-table element must be numbered. When the name parameter is associated with a shipping method in a Checkout API request, either the flat-rate-shipping or pickup element needs to be numbered. Finally, when the name parameter is associated with a promotion, the promotion element must be numbered so that the promotion name can be associated with a specific promotion.