Support

Menu

Home

Creating & Managing Your Account

Getting Paid

Managing Orders

Resolving Disputes

Integrating with Checkout by Amazon

Setting Up Customer-facing Information and Policies

Using the Checkout by Amazon Sandbox

Advanced Integration Help

Setting Up Flexible Shipping Options

Technical Resources

User Agreement & Policies

Checkout by Amazon FAQ

Setting Up Flexible Shipping Options

Flexible Shipping Options allow you to set custom shipping option labels (names) in your override shipping settings. This allows you to create your own shipping option descriptions (such as "Free Ground Shipping" or "FedEx Overnight") and then map them to the standard names used by Checkout by Amazon (such as "Standard," "Expedited," "One-Day," or "Two-Day"). This means that your customers will see the name you have chosen, and the shipping charges will be calculated using the shipping rates that you map to the applicable standard shipping method.

By using Flexible Shipping Options, you can set up to 20 custom shipping names per single shipping destination and assign each of them to the applicable shipping service levels and shipping rates, according to the following:

  • You can assign up to seven different names to the Standard and Expedited service levels.
  • You can assign up to five different names to the One-Day and Two-Day service levels.
  • You can create custom shipping names that are up to 100 characters long.

You can create these custom shipping names for each distinct shipping region. That is, you can create up to 20 custom names for shipping within the Continental U.S. and another 20 custom shipping names for shipping outside the U.S.

Flexible Shipping Options are supported for both XML- and HTML-based carts.

Note: You cannot use Flexible Shipping Options when you build checkout buttons using the Create Checkout Button generator, because you must customize your cart code, and the Create Checkout Button generator does not allow you to modify the code it creates.

For information about configuring shipping overrides in a custom cart, see the Standard Checkout HTML Implementation Guide (PDF) or the Standard Checkout XML Implementation Guide (PDF).

For information about configuring shipping overrides using callbacks, see the Callback API Guide (PDF).

Customer Experience

Your customers can view and select the Flexible Shipping Options that you specify in your button code as overrides.

Customers can see the Flexible Shipping Options on the following pages:

  • 1-Click
  • Express Checkout
  • Standard Checkout
  • Order Summary Page
  • Payments website "Your Account" page
  • New order emails

Here's an illustration of what the Flexible Shipping Options look like to the customer on the Order Summary page:

Flexible Shipping Options on the Order Summary Page

Merchant Experience

The Flexible Shipping Options selected by your customer appear in the following areas of Seller Central:

  • The Order Details page
  • The Order and Shipment Packing Slip
  • The downloadable XML-based Orders Report

The Flexible Shipping Options also appear in the XML-based notification that you receive when you use the Instant Order Processing Notification (IOPN) API.

Note: The Order Summary (listed on the Manage Orders page) does not display the Flexible Shipping Options. Instead, it displays the pre-defined shipping service level (such as Standard or Expedited). However, when you view the order details (on the Order Details page or the Orders Report), the correct shipping option appears.

Seller Central always displays the service level as well as the custom shipping label that is linked to the service level in the corresponding override shipping method that applies to the order.

Seller Central Order Details

On the Order Details page, the service level and the FlexibleShipping Options choice (selected by the buyer) appear.

Flexible Shipping Options on the Order Details Page

Seller Central Order and Shipment Packing Slip

On the Order and Shipment Packing Slip page, the Flexible Shipping Options choice appears.

Flexible Shipping Options on the Printable Packing Slip Page

Seller Central and Orders Report

The Flexible Shipping Options choice appears in a CustomizationInfo section of the Orders Report as follows:

...
  <CustomizationInfo>
              <Type>CartId</Type>
              <Data>miq://rose:1.0/cart/cba:1.0/cart:2.0/AZ4B0ZS3LGLX/A3JN8ZRLU5XWVP/2-1241714154767-D928C1251AE8F8E6</Data>
  </CustomizationInfo>
  <CustomizationInfo>
              <Type>orderChannel</Type>
              <Data>Amazon Checkout (Live)</Data>
  </CustomizationInfo>
  <CustomizationInfo>
              <Type>CBAShipLabel</Type>
              <Data>Free Ground Shipping</Data>
  </CustomizationInfo>

Sold-Ship Now Email

The Sold-Ship Now email will display the Flexible Shipping Options choice.

Flexible Shipping Options in the Sold, Ship Now email

Instant Order Processing Notification (IOPN) API

The code you receive when you use the Instant Order Processing Notification API will show the Flexible Shipping Options the buyer selected.

<ShippingMethods>
                    
                    <DisplayableShippingLabel>
                            
                    USPS Standard Shipping

                    
                    </DisplayableShippingLabel>
...
                </ShippingMethods>

Requirements

  • Must use order.xsd date 05/15/2009 or later, which contains the new element <xs:elementname="DisplayableShippingLabel" type="xs:string" minoccurs="0" /> listed in the ShippingMethod type.
  • HTML-based carts use new form input value <input name="shipping_method_displayable_shipping_label" value="Name_to_display" type="hidden" />

Service Levels and Custom Shipping Levels

When you use Flexible Shipping Options, you must still assign one of the four service levels (Standard, Expedited, OneDay, or TwoDay) to each custom shipping name. The service level that corresponds to the custom shipping name does not appear to the buyer but is available to you in Seller Central pages and IOPN messages. The service level represents the delivery requirements (Service Level Agreement, or SLA) of a shipping option that you customized with a name defined by you.

Here are the SLAs for each of the pre-defined service levels:

Region Standard Expedited Two-Day One-Day
Continental U.S. Street

3-5 business days

1-3 business days

2 business days

1 business day

Continental U.S. PO Box

3-5 business days

1-3 business days

   
Alaska and Hawaii Street

3-7 business days

1-3 business days

   
Alaska and Hawaii PO Box

3-7 business days

1-3 business days

   
U.S. Protectorate Street

4-8 business days

2-4 business days

   
U.S. Protectorate PO Box

4-8 business days

2-4 business days

   
APO/FPO Street

18-32 business days

8-16 business days

   
APO/FPO PO Box

18-32 business days

8-16 business days

   
Canada

5-10 business days

2-4 business days

   
Europe

10-20 business days

2-4 business days

   
Asia

10-16 business days

2-5 business days

   
Outside U.S., Eur., CA, Asia

10-20 business days

2-5 business days

   

Using Flexible Shipping Options with XML-based Carts

To customize your shipping level for XML-based carts, you add the following code in your ShippingMethods section:

<ShippingMethods>
                    
                    <DisplayableShippingLabel>
                            
                    USPS Standard Shipping

                    
                    </DisplayableShippingLabel>
...
                </ShippingMethods>

For example, the following code adds the shipping methods named "USPS Standard Shipping" for the pre-defined shipping level Standard:

<?xmlversion="1.0"
                encoding="UTF-8"?> <Order
                xmlns="http://payments.amazon.com/checkout/2009-05-15/">
                    
                <ClientRequestId>CART20100731AEIOU</ClientRequestId>
                    
                <ExpirationDate>2010-08-31</ExpirationDate>
                     <Cart>
                            
                <Items>
                                  
                <Item>
                                        
                <SKU>STU434</SKU>
                                        
                <MerchantId>AEIOU1234AEIOU</MerchantId>
                                        
                <Title>OliverStops the
                Filibuster</Title>
                                        
                <Description>BySandy
                Pfarrer</Description>
                                        
                <Price>
                                                
                <Amount>13.29</Amount>
                                                
                <CurrencyCode>USD</CurrencyCode>
                                        
                </Price>
                                        
                <Quantity>1</Quantity>
                                        
                <Weight>
                                                
                <Amount>1.0</Amount>
                                                
                <Unit>lb</Unit>
                                        
                </Weight>
                                        
                <Category>Books</Category>
                                        
                <Condition>New</Condition>
                                        
                <ShippingMethodIds>
                                                
                <ShippingMethodId>item-Ship-1</ShippingMethodId>
                                                
                <ShippingMethodId>item-Ship-2</ShippingMethodId>
                                                
                <ShippingMethodId>item-Ship-3</ShippingMethodId>
                                                
                <ShippingMethodId>item-Ship-4</ShippingMethodId>
                                        
                </ShippingMethodIds>
                                  
                </Item>
                            
                </Items>    
                </Cart>    
                <ShippingMethods>
                            
                <ShippingMethod>
                                  
                <ShippingMethodId>item-Ship-1</ShippingMethodId>
                                  
                <ServiceLevel>Standard</ServiceLevel>
                                  
                <Rate>
                                        
                <WeightBased>
                                                
                <Amount>1</Amount>
                                                
                <CurrencyCode>USD</CurrencyCode>
                                        
                </WeightBased>
                                  
                </Rate>
                                  
                <IncludedRegions>
                                        
                <PredefinedRegion>USFull50States</PredefinedRegion>
                                  
                </IncludedRegions>
                                  
                <ExcludedRegions>
                                  
                </ExcludedRegions>
                                  
                <IsPOBoxSupported>false</IsPOBoxSupported>
                                  
                    <DisplayableShippingLabel>
                                                
                    USPS Standard Shipping

                                  
                    </DisplayableShippingLabel>

                            
                </ShippingMethod>
                            
                <ShippingMethod>
                                  
                <ShippingMethodId>item-Ship-2</ShippingMethodId>
                                  
                <ServiceLevel>Expedited</ServiceLevel>
                                  
                <Rate>
                                        
                <ItemQuantityBased>
                                                
                <Amount>2</Amount>
                                                
                <CurrencyCode>USD</CurrencyCode>
                                        
                </ItemQuantityBased>
                                  
                </Rate>
                                  
                <IncludedRegions>
                                        
                <PredefinedRegion>USFull50States</PredefinedRegion>
                                  
                </IncludedRegions>
                                  
                <IsPOBoxSupported>true</IsPOBoxSupported>
                                  
                    <DisplayableShippingLabel>
                                                
                    USPS Standard Shipping

                                  
                    </DisplayableShippingLabel>

                            
                </ShippingMethod>
                            
                <ShippingMethod>
                                  
                <ShippingMethodId>item-Ship-3</ShippingMethodId>
                                  
                <ServiceLevel>OneDay</ServiceLevel>
                                  
                <Rate>
                                        
                <ShipmentBased>
                                                
                <Amount>3</Amount>
                                                
                <CurrencyCode>USD</CurrencyCode>
                                        
                </ShipmentBased>
                                  
                </Rate>
                                  
                <IncludedRegions>
                                        
                <PredefinedRegion>USContinental48States
                                        
                </PredefinedRegion>
                                  
                </IncludedRegions>
                                  
                <ExcludedRegions>
                                    
                </ExcludedRegions>
                                  
                <IsPOBoxSupported>false</IsPOBoxSupported>
                                  
                    <DisplayableShippingLabel>
                                                
                    USPS Standard Shipping

                                  
                    </DisplayableShippingLabel>

                            
                </ShippingMethod>
                            
                <ShippingMethod>
                                  
                <ShippingMethodId>item-Ship-4</ShippingMethodId>
                                  
                <ServiceLevel>TwoDay</ServiceLevel>
                                  
                <Rate>
                                        
                <ShipmentBased>
                                                
                <Amount>4</Amount>
                                                
                <CurrencyCode>USD</CurrencyCode>
                                        
                </ShipmentBased>
                                  
                </Rate>
                                  
                <IncludedRegions>
                                        
                <PredefinedRegion>USFull50States</PredefinedRegion>
                                  
                </IncludedRegions>
                                  
                <ExcludedRegions>
                              
                </ExcludedRegions>
                                  
                <IsPOBoxSupported>false</IsPOBoxSupported>
                                  
                    <DisplayableShippingLabel>
                                                
                    USPS Standard Shipping

                                  
                    </DisplayableShippingLabel>

                            
                </ShippingMethod>    
                </ShippingMethods>    
                <IntegratorId>VWXYZ98765VWXYZ</IntegratorId>
                    
                <IntegratorName>www.IntegratorWorld.com</IntegratorName>
                    
                <ReturnUrl>http://www.mysite.com/shopping</ReturnUrl>
                    
                <CancelUrl>http://www.mysite.com/home</CancelUrl>
                    
                <YourAccountUrl>http://www.mysite.com/account</YourAccountUrl>
                </Order>

Using Flexible Shipping Options with HTML-based Carts

To customize your shipping level for HTML-based carts, you add the following code:

<input
                name="shipping_method_displayable_shipping_label"
                value="Name_to_display" type="hidden" />

For example, the following code adds the shipping methods named "USPS Standard Shipping," "USPS Expedited Shipping," "FedEx One-Day Shipping," and "FedEx Two-Day Shipping" for the pre-defined shipping levels Standard, Expedited, OneDay, and TwoDay:

<form method="POST"
                action="https://payments.amazon.com/checkout/AEIOU1234AEIOU">
                     <input type="hidden"
                name="item_title_1" value="Oliver Stops the Filibuster"
                />      <input type="hidden"
                name="item_merchant_id_1" value="AEIOU1234AEIOU" />
                     <input type="hidden"
                name="item_price_1" value="13.29" />    
                <input type="hidden" name="item_quantity_1" value="1"
                />      <input type="hidden"
                name="item_image_url_1" value="http://mysite.com/pix?delta.jpg"
                />      <input type="hidden"
                name="item_url_1" value="http://mysite.com/item?636"/>
                     <input type="hidden"
                name="item_sku_1" value="STU434"/>
                         <input type="hidden"
                    name="item_title_2" value="Coming Up Daisy" />
                         <input type="hidden"
                    name="item_merchant_id_2" value="AEIOU1234AEIOU" />
                         <input type="hidden"
                    name="item_price_2" value="39.49" />
                         <input type="hidden"
                    name="item_quantity_2" value="1" />
                         <input type="hidden"
                    name="item_image_url_1"
                    value="http://mysite.com/pix?beta.jpg" />
                         <input type="hidden"
                    name="item_url_2"
                    value="http://mysite.com/item?818"/>
                         <input type="hidden"
                    name="item_sku_2" value="MNO212"/>
                     <input type="hidden"
                    name="currency_code" value="USD" />
                     <input
                    name="shipping_method_service_level_1" value="standard"
                    type="hidden" />    
                        <input
                        name="shipping_method_displayable_shipping_label_1"
                        value="UPS Ground Shipping" type="hidden" />

                         <input
                    name="shipping_method_region_1" value="us_all" type="hidden"
                    />      <input
                    name="shipping_method_price_per_shipment_amount_1"
                    value="5.00" type="hidden" />
                     <input
                    name="shipping_method_service_level_2" value="expedited"
                    type="hidden" />    
                        <input
                        name="shipping_method_displayable_shipping_label_2"
                        value="UPS Expedited Shipping" type="hidden"
                        />
      <input
                    name="shipping_method_region_2" value="us_all" type="hidden"
                    />      <input
                    name="shipping_method_price_per_shipment_amount_2"
                    value="15.00" type="hidden" />
                     <input
                    name="shipping_method_service_level_3" value="two_day"
                    type="hidden" />    
                        <input
                        name="shipping_method_displayable_shipping_label_3"
                        value="UPS Two-Day Shipping" type="hidden" />

                         <input
                    name="shipping_method_region_3" value="us_all" type="hidden"
                    />      <input
                    name="shipping_method_price_per_shipment_amount_3"
                    value="20.00" type="hidden" />
                     <input
                    name="shipping_method_service_level_4" value="one_day"
                    type="hidden" />    
                        <input
                        name="shipping_method_displayable_shipping_label_4"
                        value="UPS One-Day Shipping" type="hidden" />

                         <input
                    name="shipping_method_region_4" value="us_all" type="hidden"
                    />      <input
                    name="shipping_method_price_per_shipment_amount_4"
                    value="25.00" type="hidden" />
                     <input name="cart_promotion_1"
                    value="1.98" type="hidden" />    
                    <input name="cart_promotion_type_1"
                    value="fixed_amount_off" type="hidden" / >
                     <input type="hidden"
                    name="tax_rate" value="0.10"/>    
                    <input type="hidden" name="tax_us_state_region"
                    value="WA"/>
                     <input type="image"
                    src="https://payments.amazon.com/gp/cba/button?color=orange&background=other&size=large"
                    alt="Checkoutby Amazon" />
                </form>
            

Using Flexible Shipping Options and the Instant Order Processing Notification API

To use Flexible Shipping Options with the Instant Order Processing Notification API, you will receive new information in the message we send you. When you receive this message, you must parse this new information.

The definition occurs in the order.xsd as follows:

<xs:complexType
                name="ProcessedOrder">    
                <xs:sequence>
                             ...
                            
                <xs:element name="ShippingServiceLevel"
                type="tns:ShippingServiceLevel" minOccurs="0"/>
                            
                <xs:element name="ProcessedOrderItems"
                type="tns:ProcessedOrderItems"/>
                                
                    <xs:element name="DisplayableShippingLabel"
                    type="xs:string"/>

                            
                <xs:any namespace="##any" processContents="lax"
                minOccurs="0" maxOccurs="unbounded"/>
                     </xs:sequence>
                </xs:complexType>

When you receive the Instant Order Processing Notification, the entry for the Flexible Shipping Option will look like this:

...
                                      
                    <DisplayableShippingLabel>
                                              
                    FedEx Two-Day Shipping
                                      
                    </DisplayableShippingLabel>
...

For more information about using Instant Order Processing Notification, see the Instant Order Processing Notification API Guide (PDF).

Using Flexible Shipping Options and the Callback API

If you use Flexible Shipping Options and you use callbacks, you can set the custom shipping option name in the ShippingMethods returned in the callback response XML, similar to the way you customize shipping levels in the cart XML.

The callback XML you receive will look something like this:

<ShippingMethod>
                   <ShippingMethodId>US Standard</ShippingMethodId>
                   <DisplayableShippingLabel>
                       USPS Standard Shipping
                     </DisplayableShippingLabel>
    
                <ServiceLevel>Standard</ServiceLevel>
                   <Rate>
                         <WeightBased>
                               <Amount>3.49</Amount>
                               <CurrencyCode>USD</CurrencyCode>
                         </WeightBased>
                   </Rate>
                   <IncludedRegions>
                         <USZipRegion>98104</USZipRegion>
                   </IncludedRegions>
             </ShippingMethod>

For more information about using the Callback API, see the Callback API Guide (PDF).