The Shutterfly Address Book API provides access to Shutterfly address book entries. The Shutterfly address book can be used within Shutterfly for share email-addresses, shipping recipient addresses, etc.
Description
Call Signature
Application ID and call signature are required. Please see Call Signature documentation for more details.
Resource Path
This API uses either of the following equivalent resource path elements:
- /addressbook - often paired with a Shutterfly address book entry by nickname
- Example: /addressbook/Santa
- /addressbookid - often paired with a Shutterfly address book entry by ID
- Example: /addressbookid/4b4d64b1b15ff052c580a4bd826fed44
It should appear in combination with its parent:
- User Data API - Example:
- /user/test12341234@yahoo.com/addressbook
- /userid/9AbNHLRq4ZE/addressbook/Santa
- /userid/9AbNHLRq4ZE/addressbookid/4b4d64b1b15ff052c580a4bd826fed44
Methods
- GET - Gets a listing of address book entries or a particular address book entry.
- POST - Creates a new address book entry for this user.
- PUT - Modify an existing address book entry for this user.
- DELETE - Delete an existing address book entry for this user.
Scheme
httpHost
ws.shutterfly.com| Method | Endpoint example |
|---|---|
| GET |
http://ws.shutterfly.com/user/santa@shutterfly.com/addressbook
http://ws.shutterfly.com/user/santa@shutterfly.com/addressbook/Grams http://ws.shutterfly.com/user/santa@shutterfly.com/addressbookid/00005678 |
| POST | http://ws.shutterfly.com/user/santa@shutterfly.com/addressbook |
| PUT |
http://ws.shutterfly.com/user/santa@shutterfly.com/addressbook/Santa
http://ws.shutterfly.com/userid/9AbNHLRq4ZE/addressbookid/4b4d64b1b15ff052c580a4bd826fed44 |
| DELETE |
http://ws.shutterfly.com/user/santa@shutterfly.com/addressbook/Santa
http://ws.shutterfly.com/userid/9AbNHLRq4ZE/addressbookid/4b4d64b1b15ff052c580a4bd826fed44 |
In the following Method detail sections, click on Method name to expand or collapse the detail.
Click here to expand/collapse all.
Method: GET
Gets a listing of address book entries or a particular address book entry.
User authorization
User authorization is required for this method. Please see the user authorization
documentation
for more details.
Input Parameters
Set the following on the URL:
/addressbook or /addressbookid
The identifier of the address book, either by nickname or by id. If not specified, will return a listing of all address book entries associated with the user, sorted by nickname.
Count:
0 - 1
Example:
Santa, 4b4d64b1b15ff052c580a4bd826fed44
Sample Output
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:addressbookentry="http://community.openfly.shutterfly.com/v1.0#addressbookentry">
<rights>Copyright (C) Shutterfly 1999-2009. All rights reserved.</rights>
<category term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
<author>
<name>Santa</name>
<uri>http://ws.shutterfly.com/userid/9AbNHLRq4ZE</uri>
</author>
<id>http://ws.shutterfly.com/userid/9AbNHLRq4ZE/addressbookid/
4b4d64b1b15ff052c580a4bd826fed44</id>
<addressbookentry:nickName>Santa</addressbookentry:nickName>
<addressbookentry:firstName>Kris</addressbookentry:firstName>
<addressbookentry:lastName>Kringle</addressbookentry:lastName>
<addressbookentry:address1>1 Santa Claus Lane</addressbookentry:address1>
<addressbookentry:address2/>
<addressbookentry:city>North Pole</addressbookentry:city>
<addressbookentry:region>AK</addressbookentry:region>
<addressbookentry:postCode>99705</addressbookentry:postCode>
<addressbookentry:country>USA</addressbookentry:country>
</feed>
Output Feed
feed
The response will be an atom-based XML feed of data about the address book entry.
category
<category-term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
addressbookentry:nickName
User-assigned nickname of the address book entry. This acts as a unique, human-readable identifier. Only numbers and letters are allowed (no spaces or special characters).
However, please note that some historic data may have banned characters so your system must be able to accept the characters but not return them as an update.
Count:
1
Length:
1 - 64
Example:
Santa
addressbookentry:firstName
First name
Count:
1
Length:
1 - 32
Example:
Kris
addressbookentry:lastName
Last name
Count:
1
Length:
1 - 32
Example:
Kringle
addressbookentry:email
Email address of the entry, if present must conform to standard email address
Count:
0 - 1
Length:
6 - 64
Example:
santa@shutterfly.com
addressbookentry:address1
First line of street address
Count:
1
Length:
1 - 64
Example:
1 Northpole Lane
addressbookentry:address2
Second line of street address
Count:
0 - 1
Length:
1 - 64
Example:
Suite 100
addressbookentry:city
City
Count:
1
Length:
1 - 32
Example:
North Pole
addressbookentry:region
State/province/region. For US and Canadian addresses, must conform to official two letter abbreviations. Not required for non-US/Canada addresses.
Count:
0 - 1
Length:
1 - 32
Example:
AK
addressbookentry:postCode
Postal (zip) code. Required for United States, Canada and Great Britain.
Count:
0 - 1
Length:
1 - 32
Example:
12345
addressbookentry:country
Country code, must be ISO-3166-1 alpha-3 (3 digit codes).
Count:
1
Length:
3
Example:
USA
Error Codes
If there is no error, methods return HTTP status code 200 (or 201 for a create operation). See the documentation for Common Response Codes.
If there is an error, the following API-specific codes may be returned in the HTTP response body. (Please see error messaging for details on how the error will be formatted.)
10:
ID/nickname not found
Method: POST
Creates a new address book entry for this user.
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:catinfo="http://catinfo.openfly.shutterfly.com/v1.0"
xmlns:addressbookentry="http://community.openfly.shutterfly.com/v1.0#addressbookentry">
<entry>
<category term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
<addressbookentry:nickName>Santa</addressbookentry:nickName>
<addressbookentry:firstName>Kris Kringle</addressbookentry:firstName>
<addressbookentry:lastName>Kris Kringle</addressbookentry:lastName>
<addressbookentry:address1>1 Santa Claus Lane</addressbookentry:address1>
<addressbookentry:address2/>
<addressbookentry:city>North Pole</addressbookentry:city>
<addressbookentry:region>AK</addressbookentry:region>
<addressbookentry:postCode>99705</addressbookentry:postCode>
<addressbookentry:country>USA</addressbookentry:country>
</entry>
</feed>
Submit the following as an Atom XML entry, as in the Sample Input.
addressbookentry entry
Input values of address book entry to be created. Note that you can either one of the following three types: email address only, shipping address only, or both. However, if you enter any shipping data at all (city, address1, etc.) you must enter a complete and valid shipping address - partial shipping entries are not acceptable input. The "count" field below is strictly true for the entry as a whole (due to the email-only option), but required fields for a shipping address entry are marked with a *.
category
<category-term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
addressbookentry:nickName
User-assigned nickname of the address book entry. This acts as a unique, human-readable identifier. Only numbers and letters are allowed (no spaces or special characters). However, please note that some historic data may have banned characters so your system must be able to accept the characters but not return them as an update.
Count:
1
Length:
1 - 64
Example:
Santa
addressbookentry:firstName
First name
Count:
1
Length:
1 - 32
Example:
Kris
addressbookentry:lastName
Last name
Count:
1
Length:
1 - 32
Example:
Kringle
addressbookentry:email
Email address of the entry, if present must conform to standard email address
Count:
0 - 1
Length:
6 - 64
Example:
santa@shutterfly.com
addressbookentry:address1
First line of street address
Count:
0 - 1*
Length:
1 - 64
Example:
1 Northpole Lane
addressbookentry:address2
Second line of street address
Count:
0 - 1
Length:
1 - 64
Example:
Suite 100
addressbookentry:city
City
Count:
0 - 1*
Length:
1 - 32
Example:
North Pole
addressbookentry:region
State/province/region. For US and Canadian addresses, must conform to official two letter abbreviations.
Count:
0 - 1
Length:
1 - 32
Example:
AK
addressbookentry:postCode
Postal (zip) code. Required for United States, Canada and Great Britain.
Count:
0 - 1
Length:
1 - 32
Example:
12345
addressbookentry:country
Country code, must be ISO-3166-1 alpha-3 (3 digit codes).
Count:
0 - 1*
Length:
3
Example:
USA
Sample Output
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:catinfo="http://catinfo.openfly.shutterfly.com/v1.0"
xmlns:addressbookentry="http://community.openfly.shutterfly.com/v1.0#addressbookentry">
<rights>Copyright (C) Shutterfly 1999-2009. All rights reserved.</rights>
<catinfo:categoryInfo term="all" count="1"/>
<catinfo:categoryInfo term="addressbookentry" count="1"/>
<entry>
<category term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
<author>
<name>Santa</name>
<uri>http://ws.shutterfly.com/userid/9AbNHLRq4ZE</uri>
</author>
<id>http://ws.shutterfly.com/userid/9AbNHLRq4ZE/addressbookid/
4b4d64b1b15ff052c580a4bd826fed44</id>
<addressbookentry:nickName>Santa</addressbookentry:nickName>
<addressbookentry:firstName>Kris Kringle</addressbookentry:firstName>
<addressbookentry:lastName>Kris Kringle</addressbookentry:lastName>
<addressbookentry:address1>1 Santa Claus Lane</addressbookentry:address1>
<addressbookentry:address2/>
<addressbookentry:city>North Pole</addressbookentry:city>
<addressbookentry:region>AK</addressbookentry:region>
<addressbookentry:postCode>99705</addressbookentry:postCode>
<addressbookentry:country>USA</addressbookentry:country>
</entry>
</feed>
addressbookentry entry
category
<category-term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
Error Codes
If there is no error, methods return HTTP status code 200 (or 201 for a create operation). See the documentation for Common Response Codes.
If there is an error, the following API-specific codes may be returned in the HTTP response body. (Please see error messaging for details on how the error will be formatted.)
11:
Illegal nickname
Nicknames must only contain characters and numbers.
12:
Duplicate nickname
Nicknames must be unique to a particular user.
20:
Invalid country
21:
Invalid state/region
22:
Invalid postcode
23:
Invalid address line 1
24:
Invalid address line 2
25:
Invalid city
30:
Invalid first name
31:
Invalid last name
32:
Invalid email address
Method: PUT
Modify an existing address book entry for this user.
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:catinfo="http://catinfo.openfly.shutterfly.com/v1.0"
xmlns:addressbookentry="http://community.openfly.shutterfly.com/v1.0#addressbookentry">
<entry>
<category term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
<addressbookentry:nickName>Santa</addressbookentry:nickName>
<addressbookentry:firstName>Kris Kringle</addressbookentry:firstName>
<addressbookentry:lastName>Kris Kringle</addressbookentry:lastName>
<addressbookentry:address1>1 Santa Claus Lane</addressbookentry:address1>
<addressbookentry:address2/>
<addressbookentry:city>North Pole</addressbookentry:city>
<addressbookentry:region>AK</addressbookentry:region>
<addressbookentry:postCode>99705</addressbookentry:postCode>
<addressbookentry:country>USA</addressbookentry:country>
</entry>
</feed>
Submit the following as an Atom XML entry, as in the Sample Input.
addressbookentry entry
Input values of address book entry to be updated. Note that you can either one of the following three types: email address only, shipping address only, or both. However, if you enter any shipping data at all (city, address1, etc.) you must enter a complete and valid shipping address - partial shipping entries are not acceptable input. The "count" field below is strictly true for the entry as a whole (due to the email-only option), but required fields for a shipping address entry are marked with a *.
category
<category-term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
addressbookentry:nickName
User-assigned nickname of the address book entry. This acts as a unique, human-readable identifier. Only numbers and letters are allowed (no spaces or special characters). However, please note that some historic data may have banned characters so your system must be able to accept the characters but not return them as an update.
Count:
1
Length:
1 - 64
Example:
Santa
addressbookentry:firstName
First name
Count:
1
Length:
1 - 32
Example:
Kris
addressbookentry:lastName
Last name
Count:
1
Length:
1 - 32
Example:
Kringle
addressbookentry:email
Email address of the entry, if present must conform to standard email address
Count:
0 - 1
Length:
6 - 64
Example:
santa@shutterfly.com
addressbookentry:address1
First line of street address
Count:
0 - 1*
Length:
1 - 64
Example:
1 Northpole Lane
addressbookentry:address2
Second line of street address
Count:
0 - 1
Length:
1 - 64
Example:
Suite 100
addressbookentry:city
City
Count:
0 - 1*
Length:
1 - 32
Example:
North Pole
addressbookentry:region
State/province/region. For US and Canadian addresses, must conform to official two letter abbreviations.
Count:
0 - 1
Length:
1 - 32
Example:
AK
addressbookentry:postCode
Postal (zip) code. Required for United States, Canada and Great Britain.
Count:
0 - 1
Length:
1 - 32
Example:
12345
addressbookentry:country
Country code, must be ISO-3166-1 alpha-3 (3 digit codes).
Count:
0 - 1*
Length:
3
Example:
USA
Sample Output
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:catinfo="http://catinfo.openfly.shutterfly.com/v1.0"
xmlns:addressbookentry="http://community.openfly.shutterfly.com/v1.0#addressbookentry">
<rights>Copyright (C) Shutterfly 1999-2009. All rights reserved.</rights>
<catinfo:categoryInfo term="all" count="1"/>
<catinfo:categoryInfo term="addressbookentry" count="1"/>
<entry>
<category term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
<author>
<name>Santa</name>
<uri>http://ws.shutterfly.com/userid/9AbNHLRq4ZE</uri>
</author>
<id>http://ws.shutterfly.com/userid/9AbNHLRq4ZE/addressbookid/
4b4d64b1b15ff052c580a4bd826fed44</id>
<addressbookentry:nickName>Santa</addressbookentry:nickName>
<addressbookentry:firstName>Kris Kringle</addressbookentry:firstName>
<addressbookentry:lastName>Kris Kringle</addressbookentry:lastName>
<addressbookentry:address1>1 Santa Claus Lane</addressbookentry:address1>
<addressbookentry:address2/>
<addressbookentry:city>North Pole</addressbookentry:city>
<addressbookentry:region>AK</addressbookentry:region>
<addressbookentry:postCode>99705</addressbookentry:postCode>
<addressbookentry:country>USA</addressbookentry:country>
</entry>
</feed>
addressbookentry entry
The response will be an atom-based XML feed of data about the address book entry.
category
<category-term="addressbookentry" scheme="http://site.openfly.shutterfly.com/v1.0"/>
Error Codes
If there is no error, methods return HTTP status code 200 (or 201 for a create operation). See the documentation for Common Response Codes.
If there is an error, the following API-specific codes may be returned in the HTTP response body. (Please see error messaging for details on how the error will be formatted.)
10:
ID/nickname not found
11:
Illegal nickname
Nicknames must only contain characters and numbers.
12:
Duplicate nickname
Nicknames must be unique to a particular user.
20:
Invalid country
21:
Invalid state/region
22:
Invalid postcode
23:
Invalid address line 1
24:
Invalid address line 2
25:
Invalid city
30:
Invalid first name
31:
Invalid last name
32:
Invalid email address
Method: DELETE
Delete an existing address book entry for this user.
Note: this call is permanent, cannot be undone, and has no confirmation. Don't say we didn't warn you.
User authorization
User authorization is required for this method. Please see the user authorization
documentation
for more details.
Input Parameters
Set the following on the URL:
/addressbook or /addressbookid
The identifier of the address book, either by nickname or by id.
Count:
1
Example:
Santa, 4b4d64b1b15ff052c580a4bd826fed44
Error Codes
If there is no error, methods return HTTP status code 200 (or 201 for a create operation). See the documentation for Common Response Codes.
If there is an error, the following API-specific codes may be returned in the HTTP response body. (Please see error messaging for details on how the error will be formatted.)
10:
ID/nickname not found
Frequently Asked Questions
General
I get a Shutterfly address book entry and then try to save it again, unchanged, but it says the nickname is bad. What gives?
As stated above, only numbers and letters are allowed (no spaces or special characters). However, some historic data may have banned characters already stored, so your system must be able to accept the characters but not return them as an update, that is strip them out or request a new nickname from the user.
