Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


The fields are to be interpreted as follows:

sellableIdUnique identifier for the sellable. Necessary to query the detail resource mentioned below as well as for the add-to-basket request.
ideaIdIdentifies the uploaded design. Necessary to query the detail resource but also useful to group content by design if desired.
mainDesignIdIdentifies the main image/design which is used for this Idea (usually the first design you add in the Partner Area). Can be used if you want to use  the Designs Resource in combination with this resource.
productTypeIdIdentifies the 'type of garment' used. Can be used to lookup additional meta data from the product type resources described here.
priceAlways in the currency of the shop. Check this for hints on how to format the price in a user-friendly way.
nameThe text you entered in the Partner Area.
descriptionThe text you entered in the Partner Area (optional).
tagsThe text you entered in the Partner Area (optional).
previewImageAn image we deem best suited to represent the sellable on a list page.
previewImage/urlThe image url you can embed directly into your page.
previewImage/typeDescribes the type of image available from the url using one of the following values: PRODUCT, DESIGN, MODEL, ALTERNATIVE_MODEL. 
appearanceIdsThe 'colors' a sellable currently has available for purchase. If you need more information on the colors, the product type resource here is useful. 
defaultAppearanceIdThe default 'color' you can set in the Partner Area. This is the color the previewImage is in. It also provides a good starting point when linking to a detail page.


Most of the fields are exactly the same as in the list resource and have the same semantics. Two additional fields are included:

Field nameMeaning
sizeIdsDescribes the sizes available for purchase for the sellable in this appearance. For more information on sizes, check the product type resource here.
imagesA number of images giving an adequate overview over the sellable and it's properties in this appearance when displayed (ordered from most important to least important image). The exact number and shape of the images depend on your shop settings and the specifications you set when uploading the design. This object has the same structure as previewImage (mentioned in the list resource section).