Page tree
Skip to end of metadata
Go to start of metadata

In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that you uploaded in the Partner Area. Every entry from the Sellables endpoint contains a field "mainDesignId". This id can be used to access the resource below in order to retrieve additional information about the upload. In the vast majority of implementations, this information is not necessary and it suffices to use the "Sellables" resource.

MethodURLExample
GET/api/v1/shops/<shopId>/designs/<designId>

https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757?mediaType=json


A design has the following characteristics:

  • Each design has a name, a description, a size.
  • Images: To retrieve a design image, you can use a URL similar to the following one: https://image.spreadshirtmedia.net/image-server/v1/designs/2484607. These URLs are provided within the resources part of the design payload.
  • Color Layers: Vector designs consist of one or more color layers. We provide for each color layer, the original color of the uploaded design as well as the color set by the owner as actual default color. Example:


  • Allowed Print Types: For each design, we provide a list of print types, e.g. flock, flex or digital direct print, that can be used to print that design. Vector and pixel images are printed using different print types!


Example Payload
{
   "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
   "id":"163261757",
   "created":"2019-07-08T08:03:56.000+0000",
   "modified":"2019-07-22T10:17:39.000+0000",
   "name":"I love you",
   "description":"A lovely design for you",
   "tags":"Love,Love hurts,Love me,Love parade,Love with heart,Loved,Lovestruck,You,Young money,Young wild and free,Your,Youtube,migration,shop api,test",
   "user":{
      "href":"https://api.spreadshirt.net/api/v1/users/117878306",
      "id":"117878306"
   },
   "size":{
      "width":3938.0,
      "height":1149.0,
      "unit":"px"
   },
   "colors":[

   ],
   "backgroundColor":"#666666",
   "printTypes":[
      {
         "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/17",
         "id":"17"
      },
      {
         "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/1",
         "id":"1"
      },
   ],
   "resources":[
      {
         "mediaType":"png",
         "type":"preview",
         "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757,backgroundColor=666666"
      },
      {
         "mediaType":"png",
         "type":"montage",
         "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757"
      }
   ],
}
  • No labels