The Shutterfly Pricing API provides estimated prices for Shutterfly product and shipping options. The returned prices are not guaranteed and may be subject to revision at order placement time.
Description
Call Signature
Application ID and call signature are required. Please see Call Signature documentation for more details.
Resource Path
This API uses the following resource path element:
- /pricing
Methods
- POST - Creates estimated prices for a given set of Shutterfly product and shipping options, submitted as entries in an Atom <feed>.
Scheme
httpHost
ws.shutterfly.com| Method | Endpoint example |
|---|---|
| POST | http://ws.shutterfly.com/pricing |
In the following Method detail sections, click on Method name to expand or collapse the detail.
Method: POST
Creates estimated prices for a given set of Shutterfly product and shipping options, submitted as entries in an Atom <feed>.
User authorization
User authorization is required for this method. Please see the user authorization
documentation
for more details.
Sample Input
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openfly="http://openfly.shutterfly.com/v1.0"
xmlns:sflyecom="http://openfly.shutterfly.com/ecom/v1.0">
<category term="pricing" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<entry>
<category term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>1</sflyecom:ref>
<sflyecom:firstname>Kris</sflyecom:firstname>
<sflyecom:lastname>Kringle</sflyecom:lastname>
<sflyecom:address1>1 Santa Claus Lane</sflyecom:address1>
<sflyecom:address2></sflyecom:address2>
<sflyecom:city>North Pole</sflyecom:city>
<sflyecom:state>AK</sflyecom:state>
<sflyecom:postcode>99705</sflyecom:postcode>
<sflyecom:country>USA</sflyecom:country>
<sflyecom:shippingtype>1DAY</sflyecom:shippingtype>
</entry>
<entry>
<category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>4</sflyecom:ref>
<sflyecom:productdetail>
<sflyecom:print>
<sflyecom:finish>G</sflyecom:finish>
</sflyecom:print>
</sflyecom:productdetail>
<sflyecom:sku>5x7</sflyecom:sku>
<sflyecom:qty>10</sflyecom:qty>
<sflyecom:recipient>1</sflyecom:recipient>
</entry>
<entry>
<category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>5</sflyecom:ref>
<sflyecom:sku>MUG01</sflyecom:sku>
<sflyecom:qty>1</sflyecom:qty>
<sflyecom:recipient>1</sflyecom:recipient>
</entry>
</feed>
Submit the following as an Atom XML feed, as in the Sample Input.
Content-Type
application/atom+xml
feed
category
<category-term="pricing" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
Submit the following as an Atom XML entry, as in the Sample Input.
recipient entry
A recipient - each address shipped to must contain separate recipient information. Note that at this time, only a single recipient per order is supported.
category
<category-term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:ref
Client-defined reference for this recipient. This string will be referenced in pricing response and used for mapping
items and other objects to a particular recipient. Must be unique within the same category in the same order.
Count:
1
Example:
1
sflyecom:firstname
First name
Count:
1
Length:
1 - 16
Example:
Kris
sflyecom:lastname
Last name
Count:
1
Length:
1 - 16
Example:
Kringle
sflyecom:address1
First line of address
Count:
1
Length:
1 - 64
Example:
1 Santa Claus Ln.
sflyecom:address2
Second line of address, optional
Count:
0 - 1
Length:
1 - 64
Example:
Suite 101
sflyecom:city
City
Count:
1
Length:
1 - 32
Example:
North Pole
sflyecom:state
State/region information. For US and Canada, must conform to official two letter abbreviations. Not required for non-US/Canada addresses.
Count:
0 - 1
Length:
1 - 32
Example:
AK
sflyecom:postcode
Postal (zip) code
Count:
1
Length:
1 - 10
Example:
99705
sflyecom:country
Country code, must be ISO-3166-1 alpha-3 (3 digit codes).
Count:
1
Length:
3
Example:
USA
sflyecom:shippingtype
Desired shipping type for this recipient. Note that this is a logical shipping type - actual carrier and method selection is done
by Shutterfly and cannot be specified. The examples below are just that - examples - and do not imply what carrier or method
Shutterfly will select for the order. Also, if this element is missing or not applicable for the recipient address, a default shipping
option - usually STANDARD - will be automatically chosen.
Count:
1
Example:
STANDARD
Possible Values:
STANDARD
Standard shipping, such as USPS First Class Mail
PRIORITY
Standard shipping, such as USPS Priority Mail
2DAY
Two day shipping, such as UPS Second Day Air
1DAY
One day shipping, such as UPS Next Day Air
INTLCAN
International shipping to Canadian addresses
INTLSTD
International shipping to all other addresses
Submit the following as an Atom XML entry, as in the Sample Input.
item entry
An item to be ordered. Note: each unique combination is considered its own item and must have an entry defined. For example, 100 4x6 prints of the same image would be a single item, qty 100. In contrast, if each 4x6 was a different image, this is considered 100 different item entries. This same concept holds for any other variation - for example, print finish (Matte/Glossy), price, sku, etc.
category
<category-term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:productdetail
This field contains xml which describes attributes unique for this sku. For instance, a 4x6 sku would require a product detail that
included print finish (Matte/Glossy), while a mug sku would not require such an attribute (there is no finish concept for mugs).
Count:
1
Example:
See sample xml
sflyecom:sku
Shutterfly sku for product desired.
Count:
1
Example:
MUG01
Possible Values:
4x6
4x6 print
5x7
5x7 print
8x10
8x10 print
11x14
11x14 print
16x20
16x20 print
20x30
20x30 print
NOTECARD01
Box of 12 note cards
MUG01
11 oz. white mug
MUG02
15 oz. white mug
MUG04
11 oz. black mug
TILEDMUG01
11 oz. tiled mug
TILEDMUG02
15 oz. tiled mug
TSHIRT01
T-shirt, adult small
TSHIRT02
T-shirt, adult medium
TSHIRT03
T-shirt, adult large
TSHIRT04
T-shirt, adult XL
TSHIRT05
T-shirt, adult XXL
TSHIRT11
T-shirt, youth small
TSHIRT12
T-shirt, youth medium
TSHIRT13
T-shirt, youth large
PUZZLE01
Puzzle
KEYCHAIN01
Pewter key ring
sflyecom:qty
Qty of this item
Count:
1
Amount:
>= 1
Example:
10
sflyecom:recipient
Recipient reference of the recipient for this item. Must match sflyecom:ref entry of a recipient.
Count:
1
Example:
1
Sample Output
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openfly="http://openfly.shutterfly.com/v1.0"
xmlns:sflyecom="http://openfly.shutterfly.com/ecom/v1.0">
<category term="pricing" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ordertotal>38.71</sflyecom:ordertotal>
<entry>
<category term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>1</sflyecom:ref>
<sflyecom:firstname>Kris</sflyecom:firstname>
<sflyecom:lastname>Kringle</sflyecom:lastname>
<sflyecom:address1>1 Santa Claus Lane</sflyecom:address1>
<sflyecom:address2></sflyecom:address2>
<sflyecom:city>North Pole</sflyecom:city>
<sflyecom:state>AK</sflyecom:state>
<sflyecom:postcode>99705</sflyecom:postcode>
<sflyecom:country>USA</sflyecom:country>
<sflyecom:shippingtype>1DAY</sflyecom:shippingtype>
<sflyecom:productcost>21.09</sflyecom:productcost>
<sflyecom:shippingcost>15.99</sflyecom:shippingcost>
<sflyecom:tax>1.63</sflyecom:tax>
<sflyecom:discount>0.00</sflyecom:discount>
<sflyecom:recipienttotal>38.71</sflyecom:recipienttotal>
<sflyecom:shippingoptions>
<sflyecom:shippingoption name="STANDARD" cost="1.99" usualminshipping="3" usualmaxshipping="7"/>
<sflyecom:shippingoption name="PRIORITY" cost="5.99" usualminshipping="3" usualmaxshipping="5"/>
<sflyecom:shippingoption name="2DAY" cost="10.99" usualminshipping="2" usualmaxshipping="2"/>
<sflyecom:shippingoption name="1DAY" cost="15.99" usualminshipping="1" usualmaxshipping="1"/>
</sflyecom:shippingoptions>
</entry>
<entry>
<category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>5</sflyecom:ref>
<sflyecom:productdetail>
<sflyecom:print>
<sflyecom:finish>G</sflyecom:finish>
</sflyecom:print>
</sflyecom:productdetail>
<sflyecom:sku>5x7</sflyecom:sku>
<sflyecom:skudescription>5x7 print</sflyecom:skudescription>
<sflyecom:qty>10</sflyecom:qty>
<sflyecom:unitprice>0.99</sflyecom:unitprice>
<sflyecom:itemsubtotal>9.90</sflyecom:itemsubtotal>
<sflyecom:recipient>1</sflyecom:recipient>
</entry>
<entry>
<category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:ref>6</sflyecom:ref>
<sflyecom:sku>MUG01</sflyecom:sku>
<sflyecom:skudescription>14 oz black mug</sflyecom:skudescription>
<sflyecom:qty>1</sflyecom:qty>
<sflyecom:unitprice>11.19</sflyecom:unitprice>
<sflyecom:itemsubtotal>11.19</sflyecom:itemsubtotal>
<sflyecom:recipient>1</sflyecom:recipient>
</entry>
<entry>
<category term="shipment" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
<sflyecom:shipment estimate="true"/>
<sflyecom:mindelivery>2008-01-10</sflyecom:mindelivery>
<sflyecom:maxdelivery>2008-01-12</sflyecom:maxdelivery>
<sflyecom:recipient>1</sflyecom:recipient>
<sflyecom:item>
<sflyecom:sku>5x7</sflyecom:sku>
<sflyecom:qty>10</sflyecom:qty>
</sflyecom:item>
<sflyecom:item>
<sflyecom:sku>MUG01</sflyecom:sku>
<sflyecom:qty>1</sflyecom:qty>
</sflyecom:item>
</entry>
</feed>
Output Feed
Content-Type
application/atom+xml
feed
category
<category-term="order" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:ordertotal
The total priced charge for this order.
Count:
1
Amount:
>= 0
Example:
35.03
recipient entry
category
<category-term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:productcost
Cost of products for this recipient.
Count:
1
Amount:
>= 0
Example:
21.09
sflyecom:shippingcost
Cost of shipping for this recipient. Note: if the customer has a discount granting free permission or the like, this may not match
the cost of the shipping option in the shipping methods returned. That is, this could return 0.00 due to a free shipping discount in the user's
account.
Count:
1
Amount:
>= 0
Example:
15.99
sflyecom:tax
Cost of tax for this recipient.
Count:
1
Amount:
>= 0
Example:
1.63
sflyecom:discount
Discount for this recipient. Should be less than or equal to zero. Optional, may be not set if there is no discount amount. Note:
This does NOT include free shipping, the shipping cost will be set to zero.
Count:
0 - 1
Amount:
<= 0
Example:
-5.25
sflyecom:recipienttotal
Total cost for this recipient. Should equal the sum of product, shipping, tax and discount amounts for this recipient.
Count:
1
Amount:
>= 0
Example:
33.46
sflyecom:shippingoptions
List of shipping options available for this recipient, see sflyecom:shippingoption
Count:
1
sflyecom:shippingoption@name
Possible shipping type, see possible values under sflyecom:shippingtype
Count:
1
Example:
STANDARD
sflyecom:shippingoption@cost
Cost for this recipient if this shipping option is chosen.
Count:
1
Amount:
>= 0
Example:
1.99
sflyecom:shippingoption@usualminshipping
Usual minimum shipping for this shipping type. Note that this is a "usual" shipping time only and does not include production time.
Count:
1
Amount:
>= 0
Example:
3
sflyecom:shippingoption@usualmaxshipping
Usual maximum shipping for this shipping type. Note that this is a "usual" shipping time only and does not include production time.
Count:
1
Amount:
>= 0
Example:
5
item entry
Resulting item. Note that the pricing mechanism may change the order item as passed in due to a variety of circumstances. For example, say that a user has 15 free prints in their account. If that user orders quantity 20 of the same print, the item may likely be split into two items - one of qty 15, and one of qty 5.
category
<category-term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:skudescription
Human-readable description of this sku.
Count:
1
Example:
4x6 print
sflyecom:unitprice
Unit price for this item.
Count:
1
Amount:
>= 0
Example:
0.99
sflyecom:itemsubtotal
Subtotal for this item - qty * unit price
Count:
1
Amount:
>= 0
Example:
9.90
shipment entry
Estimated shipment. Note that this is not a guarantee of quantity, content, or arrival time of shipments - this is our best estimate at the current time.
category
<category-term="shipment" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>
sflyecom:shipment
Attribute defines whether this is a estimated shipment - which it will certainly be at this time.
Count:
1
Example:
estimate=true
sflyecom:mindelivery
Estimated minimum delivery date. Note that these dates are the combination of production time and carrier delivery. Format
is YYYY-MM-DD.
Count:
1
Length:
10
Example:
2008-01-01
sflyecom:maxdelivery
Estimated maximum delivery date. Note that these dates are the combination of production time and carrier delivery. Format
is YYYY-MM-DD.
Count:
1
Length:
10
Example:
2008-01-03
sflyecom:item
Item that will be included in this estimated shipment
sflyecom:item/sku
Sku of item in this estimated shipment
Count:
1
Example:
4x6
sflyecom:item/qty
Quantity of the sku in this estimated shipment
Count:
1
Amount:
>= 1
Example:
10
Error Codes
If there is no error, methods always return HTTP status code 200 (or 201 for a create operation). See Common Response Codes documentation.
This API has no specific error codes, only the common HTTP responses will be returned.
