NAME

Google::Checkout::General::ShippingRestrictions

SYNOPSIS

  use Google::Checkout::XML::Constants;
  use Google::Checkout::General::ShippingRestrictions;
  use Google::Checkout::General::MerchantCalculatedShipping;

  my $restriction = Google::Checkout::General::ShippingRestrictions->new(
                    allowed_zip           => ["94*"],
                    excluded_zip          => ["90*"],
                    excluded_country_area => [Google::Checkout::XML::Constants::FULL_50_STATES]);

  my $custom_shipping = Google::Checkout::General::MerchantCalculatedShipping->new(
                        price         => 45.99,
                        restriction   => $restriction,
                        shipping_name => "Custom shipping");

DESCRIPTION

This module is used to define shipping restrictions which can then be added as part of a shipping method.

new HASH

Constructor. Takes a hash as its argument with the following keys: ALLOWED_STATE, array reference of allowed states; ALLOWED_ZIP, array reference of allowed zip code; ALLOWED_COUNTRY_AREA, array reference of allowed country area; EXCLUDED_STATE, array reference of excluded states; EXCLUDED_ZIP, array reference of excluded zip codes, EXCLUDED_COUNTRY_AREA, array reference of excluded country area. For ALLOWED_ZIP and EXCLUDED_ZIP, it's possible to use the wildcard operator (*) to specify a range of zip codes as in "94*" for all zip codes starting with "94".

get_allowed_state

Returns the allowed states (array reference).

add_allowed_state STATE

Adds another allowed state.

get_allowed_zip

Returns the allowed zip codes (array reference).

add_allowed_zip ZIP

Adds another allowed zip code. Zip code can have the wildcard operator to specify a range of zip codes.

get_allowed_country_area

Returns the allowed country area (array reference).

add_allowed_country_area AREA

Adds another allowed country area. Currently, the only supported country area is Google::Checkout::XML::Constants::FULL_50_STATES.

get_excluded_state

Returns the excluded states (array reference).

add_excluded_state STATE

Adds another excluded state.

get_excluded_zip

Returns the excluded zip codes (array reference).

add_excluded_zip ZIP

Adds another excluded zip code. Zip code can have the wildcard operator to specify a range of zip codes.

add_excluded_country_area AREA

Adds another excluded country area. Currently, the only supported country area is Google::Checkout::XML::Constants::FULL_50_STATES.

COPYRIGHT

Copyright 2006 Google. All rights reserved.