API Documentation

Description

The Shutterfly Order Submission API lets a client application submit a product order to the Shutterfly fulfillment system. The protocol uses synchronous order submission and asynchronous image uploading and confirmation.

For more information, please see the order how-to document.

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:

/order - often paired with a Shutterfly order ID

Example: /order/000012345678-8000012

It is the parent of these other resources (note this is not a full list of possible children):

Order Image - Example:

/order/000012345678-8000012/image
/order/000012345678-8000012/image/67b0de21b3022c546538

Order State - Example:

/order/000012345678-8000012/orderstate

Methods

POST - Places an order with Shutterfly. The caller submits an Atom feed whose entries are similar to what was returned by the Pricing API.

Scheme

http

Host

ws.shutterfly.com

Method Endpoint example

POST http://ws.shutterfly.com/order

Method	Endpoint example

POST	http://ws.shutterfly.com/order

In the following Method detail sections, click on Method name to expand or collapse the detail.

Method: POST

Places an order with Shutterfly. The caller submits an Atom feed whose entries are similar to what was returned by the Pricing API.

Https

Secure http (https) is required for this method. Http requests will not be accepted.

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="order" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
  <sflyecom:ordertotal>38.71</sflyecom:ordertotal>
  <entry>
    <category term="billinginfo" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:name>Kris Kringle</sflyecom:name>
    <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>
  </entry>
  <entry>
    <category term="creditcardinfo" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:name>Kris Kringle</sflyecom:name>
    <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:creditcardnum>5105-1051-0505-1051</sflyecom:creditcardnum>   
    <sflyecom:creditcardtype>MC</sflyecom:creditcardtype>
    <sflyecom:creditcardexpirationmonth>1</sflyecom:creditcardexpirationmonth>
    <sflyecom:creditcardexpirationyear>2010</sflyecom:creditcardexpirationyear>
  </entry>
  <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>
  </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:image type="TO_BE_UPLOADED">i1</sflyecom:image>
    </sflyecom:productdetail>
    <sflyecom:sku>5x7</sflyecom:sku>
    <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>5</sflyecom:ref>
    <sflyecom:productdetail>
       <sflyecom:singleimageproduct/>
       <sflyecom:image type="TO_BE_UPLOADED">i2</sflyecom:image>
    </sflyecom:productdetail>
    <sflyecom:sku>MUG01</sflyecom:sku>
    <sflyecom:qty>1</sflyecom:qty>
    <sflyecom:unitprice>11.19</sflyecom:unitprice>
    <sflyecom:itemsubtotal>11.19</sflyecom:itemsubtotal>
    <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="order" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:ordertotal

The total charge for this order, as priced previously. If price is different than passed in, error will result. Note that it is possible, although highly unlikely, that Shutterfly prices will have changed between the time of the pricing and order calls.

Count: 1

Example: 35.03

Submit the following as an Atom XML entry, as in the Sample Input.

billinginfo entry

Billing information for the order.

category

<category-term="billinginfo" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:name

Full name

Count: 1

Length: 1-32

Example: Kris 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

US Abbreviations

Canadian Abbreviations

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

ISO-3166-1

Submit the following as an Atom XML entry, as in the Sample Input.

creditcardinfo entry

Credit card information for the order. Credit card is the only form of payment currently accepted via this API.

category

<category-term="creditcardinfo" scheme=" http://openfly.shutterfly.com/ecom/v1.0 "/>

sflyecom:creditcardnum

Credit card number that will be charged upon shipment of order.

Count: 1

Example: 5105-5105-5105-5105

sflyecom:creditcardtype

Type of credit card to be used

Count: 1

Example: MC

Possible Values:

Mastercard

VISA

Visa

AMEX

American Express

DISC

Discover

sflyecom:creditcardexpirationmonth

Integer month of card expiration, 1 (January) - 12 (December)

Count: 1

Example: 1

sflyecom:creditcardexpirationyear

Year of card expiration

Count: 1

Example: 2010

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 order response and used for mapping items and other objects to a particular recipient. Note: This reference will NOT be stored by Shutterfly. After the API response, this reference will have no further meaning, as it will be replaced by Shutterfly specific reference. Must be unique within the same category in the same order.

Count: 1

Example: 1

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.

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

List of details

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:unitprice

Unit price for this item, as defined by pricing API output.

Count: 1

Amount: >= 0

Example: 0.99

sflyecom:itemsubtotal

Subtotal for this item - qty * unit price

Count: 1

Amount: >= 0

Example: 9.90

sflyecom:recipient

Recipient reference of the recipient for this item. Must match sflyecom:ref entry of a recipient.

Count: 1

Example: 1

Sample Output

<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="order" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
  <id>http://ws.shutterfly.com/order/000012345678-8000012</id>
  <sflyecom:ordernum>000012345678-8000012</sflyecom:ordernum>
  <sflyecom:ordertotal>38.71</sflyecom:ordertotal>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/orderstate</id>
    <category term="orderstate" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <link rel="update" type="application/atom+xml"
          href="http://ws.shutterfly.com/order/000012345678-8000012/orderstate" />
    <sflyecom:orderstate>WAITING_FOR_UPLOAD</sflyecom:orderstate>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/billinginfo</id>
    <category term="billinginfo" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:name>Kris Kringle</sflyecom:name>
    <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>
  </entry>
  <entry>
  	<id>http://ws.shutterfly.com/order/000012345678-8000012/creditcardinfo</id>
    <category term="creditcardinfo" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:name>Kris Kringle</sflyecom:name>
    <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:creditcardnum>xxxxxxxxxxxxxx5100</sflyecom:creditcardnum>   
    <sflyecom:creditcardtype>MC</sflyecom:creditcardtype>
    <sflyecom:creditcardexpirationmonth>01</sflyecom:creditcardexpirationmonth>
    <sflyecom:creditcardexpirationyear>2010</sflyecom:creditcardexpirationyear>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/recipient/33d66da8e87e8def</id>
    <category term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:ref>33d66da8e87e8def</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>CA</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>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/item/ddd66da8e87e8def</id>
    <category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:ref>ddd66da8e87e8def</sflyecom:ref>
    <sflyecom:originalid>4</sflyecom:originalid>
    <sflyecom:productdetail>
       <sflyecom:print>
           <sflyecom:finish>G</sflyecom:finish>
       </sflyecom:print>
       <sflyecom:image>60d66da8e87e8def</sflyecom:image>
    </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>33d66da8e87e8def</sflyecom:recipient>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/item/dfd66da8e87e8def</id>
    <category term="item" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:ref>dfd66da8e87e8def</sflyecom:ref>
    <sflyecom:productdetail>
       <sflyecom:singleimageproduct/>
       <sflyecom:image>10d66da8e87e8def</sflyecom:image>
    </sflyecom:productdetail>
    <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>33d66da8e87e8def</sflyecom:recipient>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/shipment/82d66da8e87e8def</id>
    <category term="shipment" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <sflyecom:ref>82d66da8e87e8def</sflyecom:ref>
    <sflyecom:shipment estimate="true"/>
    <sflyecom:mindelivery>2008-01-10</sflyecom:mindelivery>
    <sflyecom:maxdelivery>2008-01-12</sflyecom:maxdelivery>
    <sflyecom:recipient>33d66da8e87e8def</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>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/image/60d66da8e87e8def</id>
    <category term="image" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <link rel="update" type="image/jpeg"
          href="http://up.shutterfly.com/order/000012345678-8000012/image/60d66da8e87e8def"/>
    <sflyecom:ref>60d66da8e87e8def</sflyecom:ref>
    <sflyecom:originalref>i1</sflyecom:originalref>
    <sflyecom:imagestate>TO_BE_UPLOADED</sflyecom:imagestate>
  </entry>
  <entry>
    <id>http://ws.shutterfly.com/order/000012345678-8000012/image/10d66da8e87e8def</id>
    <category term="image" scheme="http://openfly.shutterfly.com/ecom/v1.0" />
    <link rel="update" type="image/jpeg"
          href="http://up.shutterfly.com/order/000012345678-8000012/image/10d66da8e87e8def"/>
    <sflyecom:ref>10d66da8e87e8def</sflyecom:ref>
    <sflyecom:originalref>i2</sflyecom:originalref>
    <sflyecom:imagestate>TO_BE_UPLOADED</sflyecom:imagestate>
  </entry>
</feed>

Output Feed

Content-Type

application/atom+xml

feed

category

<category-term="order" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:ordernum

Shutterfly order number, unique.

Count: 1

Length: 20

Example: 000012345678-8000012

billinginfo entry

category

<category-term="billinginfo" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

creditcardinfo entry

category

<category-term="creditcardinfo" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:creditcardnum

Input credit card number. Whole number will NOT be echoed back to client - response will either be suffix only or number will be abstracted with asterisks except for suffix.

Count: 1

Example: 5104

recipient entry

category

<category-term="recipient" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:ref

Shutterfly recipient reference

Count: 1

Example: 33d66da8e87e8def

image entry

category

<category-term="image" scheme="http://openfly.shutterfly.com/ecom/v1.0"/>

sflyecom:imagestate

State of image, usually either that it requires uploading or not.

Count: 1

Example: TO_BE_UPLOADED

Possible Values:

TO_BE_UPLOADED

Shutterfly does NOT have this image stored, it requires client to upload image prior to order proceeding.

READY

Shutterfly has this image stored, and it is ready for use.

sflyecom:originalref

Echo of input sflyecom:ref for client mapping purposes

Count: 1

Example: 3

item entry

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

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 - how we believe that we will ship (part of) this order, or an actual shipment.

Count: 1

Example: estimate=true

sflyecom:mindelivery

Estimated minimum delivery date. Note that these dates are for production of the items as well as time for carrier delivery. Format is YYYY-MM-DD.

Count: 1

Example: 2008-01-01

sflyecom:maxdelivery

Estimated maximum delivery date. Note that these dates are for production of the items as well as time for carrier delivery. Format is YYYY-MM-DD.

Count: 1

Example: 2008-01-03

sflyecom:item

XML with two elements for shipping estimates - sku and qty.

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.

If there is an error, the following codes may be returned. (Please see error messaging for details on how the error will be formatted.)

10 : Invalid credit card type

11 : Invalid credit card expiration month

12 : Invalid credit card expiration year

13 : Invalid credit card name

14 : Invalid credit card number

20 : Invalid country

21 : Invalid state

22 : Invalid postcode

30 : Invalid quantity for item

31 : Invalid item

This is a generic error, check status message to get details as error can vary by product type (finish, orientation, etc.)

32 : Invalid sku for item

40 : Invalid or missing image for item

50 : Missing billing information entry

51 : Missing credit card information entry

52 : Invalid recipient reference

53 : No items for recipient

55 : Missing pricing amount

100 : Invalid category for entry

Shutterfly Open API | Order

Description

Call Signature

Resource Path

Methods

Scheme

Host

Method: POST

Https

User authorization

Sample Input

feed

billinginfo entry

creditcardinfo entry

recipient entry

item entry

Sample Output

Output Feed

feed

billinginfo entry

creditcardinfo entry

recipient entry

image entry

item entry

shipment entry

Error Codes