Changelists

Upcoming Releases (Dates are very approximate)

Not Scheduled

Error fixes:

Section images are not taking effect on the web site when set in store.saveSection.cp. This will be fixed.

product.findByDesign.cp is not returning all designs.

default single color products to the single color, so default=true doesn't have to be specified for that color.

product.save.cp requires a memberId attribute in the product XML when updating a product. This will be fixed so that memberId can be omitted.

Features

Add listStoreContents and listSectionContents that provides a paginated listing of stores, sections, and product XML so users don't need to query for the store structure before querying for products.

Add top-level data for product, store, and section listings to give the attributes of the group-by objects. Example product.listByStore.cp can show store attributes in the <products> element. (http://developer.cafepress.com/forum/read/48856)

Add optional merchandiseIds parameter to product.findByDesigns.cp

Add design.saveAll.cp and allow it and design.save.cp to updates tags and categories.

Add marketplaceOptOut flag

Released July 23rd, 2009

Features:

design.findByFolderName.cp was added.

Released July 21st, 2009

Error fixes:

SVG that is not square 3000x2000 rasterized as square (http://developer.cafepress.com/forum/read/48988) This will be released separately since it is image rendering related.

Released June 18th, 2009

Features

Add perspectives attribute to mediaConfigurations

Add merchandise filtering to product.listByStore(Section) and product.countByStore(Section)

Add marketplace prices to product search results.

mediaConfigurations that cannot take designs are now marked isEditable="false"

Released June 4, 2009

Error fixes:

The product XML marketplaceUrl repeats www.cafepress. This will be fixed.

change fieldType meanings. Writable fields will be anything that is required or that can be changed. Optional will mean any field that can be edited, but that is not required (the present meaning of writable)

Remove upload limit size of SVG

Enable sortPriority field in section XML for reads and saves.

Calls that return an error now return with a 400 HTTP code

Features

add storeUri to indicate the store

add marketplacePrice to account for new marketplace pricing.

Add a default attribute to the mediaRegions and mediaConfigurations of merchandise and product, respectively, so that it is obvious which mediaRegion of a single perspective is the default. For example, shirts have a frontPocket and a frontCenter, so frontCenter should be marked as the default.

Released Wednesday May 13th, 2009

Features:
product.findByDesign.cp will be implemented.

Elimination of version 1 of the API. This version is unstable and needs to go away.
The version parameter, v, will be required. The only valid version will be 3 until a new API version is released.
Adding a location parameter so applications that make server-side requests can specify what location context they want in the results (e.g. currency type.) Values are location=US | AU | CA | GB. US is the default

Adding a paginated product listing of all products in a store, including all products of child sections.
Adding an isSellable field to the product data. Products that are pending, meaning incomplete, will be marked isSellable="false"
Adding productURL and product marketplaceURL to product results
product.saveAll will allow multiple products to be saved with one call.
adding categoryCaption and categoryId to the merchandise XML definition. This is the same data already present in the product XML

Bugs:

Store and section markups will be honored. You can specify a markup category or an absolute markup as on the web site for new products of a store or section.

Remove extra merchandise from merchandise.list.cp that is not available.

Reintroduce book and CD listings that were removed accidently

April 21, 2009

Fixes

product.listByStoreSection.cp will no longer list out-of-date merchandise and no longer list pending products.

Updating the design on products now correctly updates the product XML image URLs. Previously the old version of the product was returned by the URLs.

Image upload authentication problems will be fixed.

product.advancedSearch.cp will no longer require a merchandiseIds parameter, which will return all merchandise. Mugs (productType=0) will be searchable.

mediaConfiguration height can be set if you wish for a design to be less than the greatest possible size.

search results are putting the productId in some URLs instead of the sectionId. This will be fixed.

design.count.cp?foldernName=x will return the correct count if there are more than 256 designs. It was capped incorrectly at 256.

Features

Product paging! You will be able to request a page worth of products (like the current design methods.)

http://open-api.cafepress.com/product.countByStoreSection.cp?v=3&appKey=APP_KEY&storeId=STORE_ID&sectionId=SECTION_ID
http://open-api.cafepress.com/product.listByStoreSection.cp?v=3&appKey=APP_KEY&storeId=STORE_ID&sectionId=SECTION_ID&page=PAGE&pageSize=PAGE_SIZE
http://open-api.cafepress.com/product.countByStore.cp?v=3&appKey=APP_KEY&storeId=STORE_ID&page=0&pageSize=5
http://open-api.cafepress.com/product.listByStore.cp?v=3&appKey=APP_KEY&storeId=STORE_ID&page=0&pageSize=5

product sortPriority can be set the arrange the products relative to one another in the section.

Limited XML definitions. You can limit the XML returned to those fields and elements that are either required or writable:
product.getExample.cp?v=3&fieldTypes=required -- returns an example product with only the required attributes shown
product.getExample.cp?v=3&fieldTypes=writable -- returns an example product with only the writable elements and attriibtues shown

------------------

Past Releases

February 27, 2009

Fixes

MediaConfiguration height will be settable. Width will remain read-only, since the aspect ratio of the design must be preserved. (Delayed, this is coded but there are some unexpected problems. It will either be fixed in this release or the next one)

A category attribute will be added to the Design XML to reflect the category under which a design is categorized.

defaultOrientation and defaultPerspective will be settable from the Product XML definition (defaultPerspective setting is limited to front and back items, like the web site.)

product.listByStoreSection.cp errors will be fixed.

The API sample script at http://api.cafepress.com/test/default.htm now writes data to a default user so that you won't polute your account with unwanted data when you run it.

design.findSvg.cp is once again authenticated. I removed authentication in error last release.

Features

product.search.cp will accept negative merchandiseIds which in turn filters out products will those merchandiseIds. All other products matching the search will return. (Delayed - I've coded this fix but it seems there are some circustances where the negative numbers are ignored. If this fix doesn't work I'll provide a numbered list of saveable merchandise (e.g. no Flip cameras) for you to use until the fix is made.)

February 19, 2009

Fixes

store.saveStore() for nonpremium stores (isPremium="False") will be fixed.

Recent error retrieving and saving design SVG will be fixed. Important: You can no longer update SVG XML with design.save.cp. From now on this method will return a new design when you pass in an existing design. Our system no longer supports SVG XML updates.

design.find methods will no longer require a userToken. You can access anyone's designs. Methods like design.listFolders.cp still need a userToken to determine for which user to list folders, etc.

November 20th, 2008

Bug Fix

The API was not listing some products when a userToken was not specified. It will now list these products.

November 12th, 2008 (Originally Nov. 11)

Features

Relaxing Authentication

We are removing authentication from all methods on Product, Store, and Design that identify data by ids. This means that methods like product.find.cp and store.listStoreSections.cp no longer require a userToken. Only methods that take no ids, such as design.list.cp still require a userToken, since the userToken is needed to know which user's results to return.

You can continue to pass userTokens into all the methods and you must pass in a userToken if you want to retrieve data that is marked private or not visible. Private or not visible data will otherwise be omitted from lists, and findById methods will return an error if a caller tries to fetch private or not visible data without the proper userToken. Examples of data that needs a user token are stores and sections marked visible=false. A product in such a store and section cannot be accessed without an authenticating userToken.

Certain private data within XML results will also be hidden if the correct userToken is not provided. These are the following:

Store : ugradeDate, paidTill, billingOption

StoreSection: none

Product: none

Design: none

Product XML now has a sortPriority attribute

The sortPriority attribute indicates the sorting of products within a store section on the web site. Users can use this attribute to sort products to match the web site. sortPriority cannot be updated at this time, but that may be possible in the future.

October 7th, 2008

Fixes

Raster image uploads to the upload server can now be updated as designs in order to set their creator string. Updating the SVG of a design remains discouraged, as we will eventually remove the ability to update SVG and force a new design to be saved instead.

September 23rd, 2008 - Released September 24th, 2008

Fixes

store.list.cp

Features

none

September 9th, 2008 - Released September 15th, 2008
Fixes
store.list.cp to is broken. Still broken. Will be fixed in the next release.

product.save.cp does not currently acknowledge the name attribute.

storeSection's sectionImageId property is not correctly wired to the underlying system, and thus doesn't appear on the web site.

Changelists

Comments

Docs Navigation