Update for Spreadshirt API v1 Alpha Released

Today, we released a new version of API v1. Please note, that API v1 is still alpha, although it can already be used to create useful applications. We basically improved our data and image api.

The major new features are as follows:

  • we added product creation,
  • we added the design upload,
  • we added article categories for marketplace,
  • we modified the design categories structure,
  • we added missing article and design meta data,
  • we added the marketplace search for articles and designs,
  • we added a shop designs list,
  • we added a shop products list,
  • we improved basket creation.

You can checkout the new features by going to the API specifications

http://api.spreadshirt.net/api/v1/metaData/api.html
http://image.spreadshirt.net/image-server/v1/metaData/image-service.html
Continue reading “Update for Spreadshirt API v1 Alpha Released”

The Product Model (API Terminology Explained #4)

After telling you about our product type and design model in my last blog posts, I want to introduce our product model today. Knowing how our product model works, you will be able to work with existing products via our API. You will also be able to create new products which allows you for example to build mass customization applications.

Understanding the Product Model

In our terminology, a product represents a product type with designs and/or text lines applied to one or more print areas. A typical product, e.g. a product that contains the “I Heart” design from our marketplace and a text line, is illustrated in the picture above. A product has the following characteristics:

  • Core Data: Each product belongs to a user and has a price. The price is calculated based on the used product type, designs and print types + colors. Different from articles which have a fixed price set, the price for a product is calculated based on the added configurations on the fly.
  • ProductType Data: A product is created based on a specific product type. Therefore, it links a product type and a specific product type appearance, e.g. a yellow American Apparel shirt.
  • Default Values: Each product also has a set of default values. One default value is for example the defaultView attribute, that tells you which view to use when displaying a product, e.g. front or back.
  • Restrictions: The product data also always contains a set of restrictions, that tell you what you can’t do with that product. One attribute is for example the freeColorSelection attribute, that tells you whether it is allowed to order that product in another appearance (color/pattern combination).
  • Configurations: A product can have one or more configurations. A configuration applies a text or a design to a print area of the selected product type.
    A configuration is always connected to one print type, e.g. flex, flock or digi, with which that configuration is printed on the corresponding print area in the production process (I will give you more information about our print type model in one of the next blog posts). Therefore, in the configuration description, you can only use the print colors of that print type! Depending on the used print type, you can use fixed, print type specific colors, e.g. for flex, or free RGB or CMYK colors, e.g. for digital direct.
    A configuration is positioned on the print area using the offset values and has a specific size that is calculated from the design or text size.
    We differentiate between design and text configurations. To describe both types of configuration, we use SVG. We use the SVG image concept to describe design configurations and the SVG text/tspan concepts to describe text configurations.
    Please note, that we call the set of configurations applied to one product type view composition.

Continue reading “The Product Model (API Terminology Explained #4)”