Page tree

Versions Compared

Key

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

...

See LIST type description to see which other query parameters can be used in conjunction with search query parameter, such as sortOrder, sortField or spellcheck

...

Url

.../v1/shops/{shopId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/shops/40000/designs/m4298936-1

Type

ENTITY

Method

GET

Special Status Codes

 

API Keyyes

...

Url

.../api/v1/shops/{shopId}/designs

Sample

httphttps://api.spreadshirt.net/api/v1/shops/40000/designs

Type

LIST

Method

POST

Special Status Codes

 

APIKey

yes

SessionId

no (yes in case user is logged in)

...

Url

.../api/v1/shops/{shopId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/shops/40000/designs/10815

Type

ENTITY

Method

PUT

Special Status Codes

 

APIKey

yes

SessionId

no (yes in case user is logged in)

...

Url

.../api/v1/shops/{shopId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/shops/40000/designs/10815

Type

ENTITY

Method

DELETE

Special Status Codes

 

APIKey

yes

SessionId

no (yes in case user is logged in)

...

Url

.../v1/users/{userId}/designCategories

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designCategories

Type

LIST

Method

GET

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../v1/users/{userId}/designCategories/{designCategoryId}/designs

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designCategories/501/designs

Type

LIST

Method

GET

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../v1/users/{userId}/designs

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designs

Type

LIST

Method

GET

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../v1/users/{userId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/users/400000/designs/6664977

Type

ENTITY

Method

GET

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../api/v1/users/{userId}/designs

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designs

Type

LIST

Method

POST

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../api/v1/users/{userId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designs/10815

Type

ENTITY

Method

PUT

Special Status Codes

 

APIKey

yes

SessionId

yes

...

Url

.../api/v1/users/{userId}/designs/{designId}

Sample

httphttps://api.spreadshirt.net/api/v1/users/40000/designs/10815

Type

ENTITY

Method

DELETE

Special Status Codes

 

APIKey

yes

SessionId

yes

...

No Format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<design xmlns:xlink="http://www.w3.org/1999/xlink"
        xmlns="http://api.spreadshirt.net"weight="0.0" 
        xlink:href="httphttps://api.spreadshirt.net/api/v1/shops/205909/designs/m10004349-2" id="m10004349-2">
    <name>vikings</name>
    <description>vikings</description>
    <tags>vikings</tags>
    <user xlink:href="httphttps://api.spreadshirt.net/api/v1/users/2343121" id="2343121"/>
    <restrictions>
        <fixedColors>false</fixedColors>
        <ownText>true</ownText>
        <colorCount>0</colorCount>
        <obligatory>false</obligatory>
        <movable>true</movable>
        <targetView>0</targetView>
        <minimumScale>70</minimumScale>
        <visible>true</visible>
        <inverted>false</inverted>
        <denyOtherText>no</denyOtherText>
        <denyOtherDesigns>no</denyOtherDesigns>
        <allowScale>false</allowScale>
        <allowFlip>false</allowFlip>
        <allowRotate>false</allowRotate>    </restrictions>
    <size unit="mm">
        <width>200.87166666667</width>
        <height>184.15</height>
    </size>
    <colors>
        <color>
            <default>#000000</default>
            <origin>#000000</origin>
            <resources>
                <resource xlink:href="httphttps://image.spreadshirtspreadshirtmedia.net/image-server/v1/designs/10004349,colors[1]=none,colors[2]=none" type="montage" mediaType="png"/>
            </resources>
        </color>
        ...
    </colors>
    <printTypes>
        <printType xlink:href="httphttps://api.spreadshirt.net/api/v1/shops/205909/printTypes/19" id="19"/>
        ...
    </printTypes>
    <designCategories>
        <designCategory id="1000186"/>
        ...
    </designCategories>
    <price>
        <vatExcluded>3.00</vatExcluded>
        <vatIncluded>3.00</vatIncluded>
        <vat>0</vat>
        <currency xlink:href="httphttps://api.spreadshirt.net/api/v1/currencies/1" id="1"/>
    </price>
    <resources>
        <resource xlink:href="httphttps://image.spreadshirtspreadshirtmedia.net/image-server/v1/designs/10004349,width=42,height=42" type="preview" mediaType="png"/>
        <resource xlink:href="httphttps://image.spreadshirtspreadshirtmedia.net/image-server/v1/designs/10004349" type="montage" mediaType="png"/>
    </resources>
    <created>2010-06-07T19:15:11Z</created>
    <modified>2010-07-30T15:17:15Z</modified>
</design>

...

No Format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<designCategory xmlns:xlink="http://www.w3.org/1999/xlink"                
                xmlns="http://api.spreadshirt.net"                 
                type="MARKETPLACE" weight="3.0" id="1000000">    
    <name>Marketplace Designs</name>
    <designs xlink:href="httphttps://api.spreadshirt.net/api/v1/shops/205909/designCategories/1000000/designs"/>
    <designCategories>
        <designCategory type="BESTSELLER" weight="-1.0" id="b1000000">
            <name>Bestseller</name>
            <designs xlink:href="httphttps://api.spreadshirt.net/api/v1/shops/205909/designCategories/b1000000/designs"/>
        </designCategory>
        ...
    </designCategories>
    ...
</designCategory>

...

Get Location header to the created design meta data.

No Format
Location: httphttps://api.spreadshirt.net/api/v1/shops/42/designs/789

...

No Format
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<design xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://api.spreadshirt.net" id="789">
    <name>Jumpstyle DE</name>
    <description>Jumpstyle </description>
    ...
    <resources>
        <resource xlink:href="httphttps://image.spreadshirtspreadshirtmedia.net/image-server/v1/designs/789" type="montage" mediaType="image/png"/>
        ...
    </resources>
</design>

...