Developer

Documents
Apps

Welcome to the SUZURI API!

Overview

This page describes about SUZURI API v1.

HTTPS request

Developers must use HTTPS. Host name is suzuri.jp

Parameters

There are 4 type of HTTP methods for using SUZURI API, they are GET, POST, PUT, DELETE. Many API allow request including parameters. Developers have to use query string when using GET method, and use application/json type request body when using other methods.

Status codes

SUZURI API return some status codes. It returns 200 (or 204 with deleting) after operations succeed, and returns 40x or 50x when operations fail. Response body is uncertain when operation fails, so developers should confirm status code first of the all.

Rate limit

There is access ratelimitations some part of API. The informations of limitaion are included in response headers, named X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Authentication

Requests must include an access token, which is issued by the authentication flow as follows.

Access token

Access token should be included in request headers like,

Authorization: Bearer 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd

Curl command samples on this page miss header option above. Therefore, when using curl command in practice, developers should add options like below.

-H "Authorization: Bearer 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd"

Activity

It is the event that occurred in the SUZURI

Activity List

Details

Get activities list for current user.

GET /api/v1/activities

Optional Parameters

Name Type Description Example
limit string limit of Activities list (default 30) pattern: [1-9]|[1-2][0-9]|30$ 30

Curl Example

$ curl -n /api/v1/activities
 -G \
  -d limit=30

Response Example

HTTP/1.1 200 OK

{
  "activities": [
    {
      "id": "335104feaace0fe03d3348994486eaec",
      "message": "鹿さん が【去年の暮れあたりから蝶がついてきてるモグラ Tシャツ】にズッキュンしたよ。",
      "timeago": "2時間前",
      "eventType": "favorite",
      "eventAction": "provide",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "sender": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
        "profile": {
          "url": "https://suzuri.jp/",
          "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
          "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
        },
        "identities": [
          {
            "id": 1,
            "provider": "twitter",
            "uid": 1181557592,
            "nickname": "surisurikun",
            "url": "https://twitter.com/surisurikun"
          }
        ],
        "official": true
      },
      "receiver": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
        "profile": {
          "url": "https://suzuri.jp/",
          "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
          "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
        },
        "identities": [
          {
            "id": 1,
            "provider": "twitter",
            "uid": 1181557592,
            "nickname": "surisurikun",
            "url": "https://twitter.com/surisurikun"
          }
        ],
        "official": true
      },
      "event": null
    }
  ]
}

Activity Unreads Count

Details

Get number of unreads activities

GET /api/v1/activities/unreads

Curl Example

$ curl -n /api/v1/activities/unreads

Response Example

HTTP/1.1 200 OK

{
  "unreads": 3
}

LP and sale information banner

Attributes

Details

Name Type Description Example
displaySize string display size of Banner "1440w"
id integer unique identifer of Banner 1
imageUrl string image url of Banner "https://dijsur42hqnz1.cloudfront.net/assets/banner/top/2020/five-panel-cap/360-801a0bc6242bd566de9b17c1a36690f83fdbc0eb51e7aa3827334b3f363d1eba.png"

Category

Item is a product type we can create in SUZURI. For example, there is the item of 'T-Shirt' or 'Mug'.

Attributes

Details

Name Type Description Example
imageUrls string image urls of Category {"png":"/assets/images/categories/t-shirts.png"}
items array [{"id":1,"name":"t-shirt","angles":[1],"humanizeName":"スタンダードTシャツ","availablePrintPlaces":["front","back"],"defaultPrintPlace":"front","displayOrder":9,"essentialAngles":["front","back"],"extraAngles":["front-wearing-mens","front-wearing-ladies"],"iconUrls":{"png":"/assets/items/t-shirt.png"},"wearingImageUrls":{"png":"/assets/wearing_by_item/t-shirt.png"},"isMultiPrintable":true,"printPlaceDisplayNames":{"front":"前面","back":"背面"},"printPlaceForExtraAngles":{"t-shirt":{"front-wearing-mens":"front","front-wearing-ladies":"front"}},"imageDescriptions":["","","男性モデル: 179cm","女性モデル: 163cm"],"productImageUrlTemplates":{"front":"https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}\u0026printed={printed}"},"isEmbroidery":true}]
name string unique name of Category "Apparel"

Choice

Choice

Attributes

Details

Name Type Description Example
bannerUrl nullable uri url of banner image of choice "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246"
description nullable string description of Choice "猫の商品を沢山あつめてみました。"
id integer unique identifier of Choice 7
productsCount integer count of Products included by Choice 1
secret boolean flag of secret mode false
title string title of Choice "スリスリピックアップ"
user:avatarUrl nullable string url avatar image of User "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
user:displayName nullable string descriptive label for User, displayed on the screen "忍者スリスリくん"
user:id integer unique identifier of User 1
user:name string unique name of User "surisurikun"

Choice Info

Details

get info for Choice selected by id

GET /api/v1/choices/{choice_id}

Curl Example

$ curl -n /api/v1/choices/$CHOICE_ID

Response Example

HTTP/1.1 200 OK

{
  "choice": {
    "id": 7,
    "title": "スリスリピックアップ",
    "description": "猫の商品を沢山あつめてみました。",
    "secret": false,
    "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
    "productsCount": 1,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  }
}

Choice Create

Details

create Choice

POST /api/v1/choices

Required Parameters

Name Type Description Example
title string title of Choice "スリスリピックアップ"

Optional Parameters

Name Type Description Example
bannerUrl string url of Choices banner "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246"
choiceProducts/itemVariantId integer unique identifier of item_variant 1
choiceProducts/productId integer unique identifier of product 1
description string description of Choice "猫の商品を沢山あつめてみました。"

Curl Example

$ curl -n -X POST /api/v1/choices \
  -d '{
  "title": "スリスリピックアップ",
  "description": "猫の商品を沢山あつめてみました。",
  "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
  "choiceProducts": [
    {
      "productId": 1,
      "itemVariantId": 1
    }
  ]
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "choice": {
    "id": 7,
    "title": "スリスリピックアップ",
    "description": "猫の商品を沢山あつめてみました。",
    "secret": false,
    "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
    "productsCount": 1,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  }
}

Choice Delete

Details

delete Choice

DELETE /api/v1/choices/{choice_id}

Curl Example

$ curl -n -X DELETE /api/v1/choices/$CHOICE_ID \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 204 No Content

レスポンスヘッダのみ返します

Choice Add product

Details

add product to Choice

POST /api/v1/choices/{choice_id}

Optional Parameters

Name Type Description Example
itemVariantId integer id of item variant (combination of color and size) which is to be binded to product Range: 1 <= value 1
productId integer id of product which is to be added to Choice Range: 1 <= value 1

Curl Example

$ curl -n -X POST /api/v1/choices/$CHOICE_ID \
  -d '{
  "productId": 1,
  "itemVariantId": 1
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "choice": {
    "id": 7,
    "title": "スリスリピックアップ",
    "description": "猫の商品を沢山あつめてみました。",
    "secret": false,
    "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
    "productsCount": 1,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  }
}

Choice Remove product

Details

remove product from choice

POST /api/v1/choices/{choice_id}/remove

Optional Parameters

Name Type Description Example
itemVariantId integer id of item variant which is to be binded to product Range: 1 <= value 1
productId integer id of product which is to be removed from Choice Range: 1 <= value 1

Curl Example

$ curl -n -X POST /api/v1/choices/$CHOICE_ID/remove \
  -d '{
  "productId": 1,
  "itemVariantId": 1
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "choice": {
    "id": 7,
    "title": "スリスリピックアップ",
    "description": "猫の商品を沢山あつめてみました。",
    "secret": false,
    "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
    "productsCount": 1,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  }
}

Choice Update

Details

update Choice

PUT /api/v1/choices/{choice_id}/

Optional Parameters

Name Type Description Example
bannerUrl nullable uri url of banner image of choice "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246"
choiceProducts/itemVariantId integer unique identifier of item_variant 1
choiceProducts/productId integer unique identifier of product 1
description nullable string description of Choice "猫の商品を沢山あつめてみました。"
title string title of Choice "スリスリピックアップ"

Curl Example

$ curl -n -X PUT /api/v1/choices/$CHOICE_ID/ \
  -d '{
  "title": "スリスリピックアップ",
  "description": "猫の商品を沢山あつめてみました。",
  "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
  "choiceProducts": [
    {
      "productId": 1,
      "itemVariantId": 1
    }
  ]
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "choice": {
    "id": 7,
    "title": "スリスリピックアップ",
    "description": "猫の商品を沢山あつめてみました。",
    "secret": false,
    "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
    "productsCount": 1,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  }
}

Choice List

Details

choices list

GET /api/v1/choices

Optional Parameters

Name Type Description Example
limit string limit of Choice list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 15
offset string offset of list (default is 0, higher number is older) pattern: [0-9][0-9]*$ 100
userId string filtering list by User id of Choice owner pattern: [1-9][0-9]*$ 2
userName string filtering list by User name of Choice owner pattern: [\w-]*$ "surisurikun"

Curl Example

$ curl -n /api/v1/choices
 -G \
  -d limit=15 \
  -d offset=100 \
  -d userId=2 \
  -d userName=surisurikun

Response Example

HTTP/1.1 200 OK

{
  "choices": [
    {
      "id": 7,
      "title": "スリスリピックアップ",
      "description": "猫の商品を沢山あつめてみました。",
      "secret": false,
      "bannerUrl": "https://dp3obxrw75ln8.cloudfront.net/choices/banners/7.jpg?1415260246",
      "productsCount": 1,
      "user": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Favorite

Favorite is users action of favoring Product (like facebook's like or twitter's favorite)

Attributes

Details

Name Type Description Example
count integer Favorite count 3
id integer unique identifier of Favrotie 7
productId integer id of product which is favored 14

Favorite Product favorite list

Details

get Favorites info of specific product

GET /api/v1/products/{product_id}/favorites

Optional Parameters

Name Type Description Example
itemId string name of Item pattern: [1-9][0-9]*$ 1
limit string limit of Favorite list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
offset string offset of Favorite list pattern: [0-9][0-9]*$ 100

Curl Example

$ curl -n /api/v1/products/$PRODUCT_ID/favorites
 -G \
  -d itemId=1 \
  -d limit=30 \
  -d offset=100

Response Example

HTTP/1.1 200 OK

{
  "favorites": [
    {
      "id": 7,
      "count": 3,
      "productId": 14,
      "user": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Favorite User favorite List

Details

get Favorites info of specific User

GET /api/v1/users/{user_id}/favorites

Curl Example

$ curl -n /api/v1/users/$USER_ID/favorites

Response Example

HTTP/1.1 200 OK

{
  "favorites": [
    {
      "id": 7,
      "count": 3,
      "product": {
        "id": 1,
        "title": "AAスリスリくん スタンダードTシャツ",
        "published": true,
        "publishedAt": "2015-01-14 11:58:29 +0900",
        "createdAt": "2015-01-14 11:58:29 +0900",
        "updatedAt": "2015-01-14 11:58:29 +0900",
        "examplaryAngle": "back",
        "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
        "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
        "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
        "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
        "priceWithTax": 2080,
        "discountedPriceWithTax": 2288,
        "item": {
          "id": 1,
          "name": "t-shirt",
          "angles": [
            1
          ],
          "humanizeName": "スタンダードTシャツ",
          "availablePrintPlaces": [
            "front",
            "back"
          ],
          "defaultPrintPlace": "front",
          "displayOrder": 9,
          "essentialAngles": [
            "front",
            "back"
          ],
          "extraAngles": [
            "front-wearing-mens",
            "front-wearing-ladies"
          ],
          "iconUrls": {
            "png": "/assets/items/t-shirt.png"
          },
          "wearingImageUrls": {
            "png": "/assets/wearing_by_item/t-shirt.png"
          },
          "isMultiPrintable": true,
          "printPlaceDisplayNames": {
            "front": "前面",
            "back": "背面"
          },
          "printPlaceForExtraAngles": {
            "t-shirt": {
              "front-wearing-mens": "front",
              "front-wearing-ladies": "front"
            }
          },
          "imageDescriptions": [
            "",
            "",
            "男性モデル: 179cm",
            "女性モデル: 163cm"
          ],
          "productImageUrlTemplates": {
            "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
          },
          "isEmbroidery": true
        },
        "material": {
          "id": 31106,
          "title": "AAスリスリくん",
          "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
          "price": 100,
          "priceWithTax": 110,
          "violation": false,
          "published": true,
          "publishedAt": "2014-05-07 11:05:25 +0900",
          "uploadedAt": "2014-05-07 11:03:15 +0900",
          "dominantRgb": "#ffffff",
          "originalWidth": 1920,
          "originalHeight": 1080,
          "user": {
            "id": 1,
            "name": "surisurikun",
            "displayName": "忍者スリスリくん",
            "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
          }
        },
        "sampleItemVariant": {
          "id": 1,
          "price": 2080,
          "exemplary": true,
          "enabled": true,
          "isLightColor": true,
          "isDarkColor": true,
          "color": {
            "id": 1,
            "name": "white",
            "displayName": "ホワイト",
            "rgb": "#ffffff"
          },
          "size": {
            "id": 1,
            "name": "s",
            "displayName": "S"
          },
          "printPlaces": [
            {
              "id": 1,
              "place": "front",
              "price": 500,
              "itemVariantId": 2
            }
          ],
          "priceWithTax": 2288
        }
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Favorite Create

Details

create Favorite to Product

POST /api/v1/products/{product_id}/favorites

Optional Parameters

Name Type Description Example
anonymouse boolean If you need anonymouse favorite, set true true
count integer Favorite count of updates (max: 100) 10

Curl Example

$ curl -n -X POST /api/v1/products/$PRODUCT_ID/favorites \
  -d '{
  "anonymouse": true,
  "count": 10
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 201 Created

{
  "favorite": {
    "id": 7,
    "count": 3,
    "rotation": 138,
    "x": 0.5702,
    "y": 0.5702
  },
  "meta": {
    "totalCount": 10
  }
}

Favorite Delete

Details

Delete favorite.

DELETE /api/v1/products/{product_id}/favorites

Curl Example

$ curl -n -X DELETE /api/v1/products/$PRODUCT_ID/favorites \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "id": 7,
  "count": 3,
  "productId": 14
}

Identity

auth providers

Attributes

Details

Name Type Description Example
id integer unique identifier of Identity 1
nickname nullable string user nickname for provider "surisurikun"
provider string user\'s web page "twitter"
uid nullable string user id for provider 1181557592
url nullable string user page url for provider "https://twitter.com/surisurikun"

Item

Item is a product type we can create in SUZURI. For example, there is the item of 'T-Shirt' or 'Mug'.

Attributes

Details

Name Type Description Example
angles array angles of Item (used when generate item image) [1]
availablePrintPlaces array printable places ["front","back"]
defaultPrintPlace string print place which is selected as exemplary by default "front"
displayOrder integer sort order for displaying items list 9
essentialAngles array angles that can be selected as the examplary angle ["front","back"]
extraAngles array angles that cannot be selected as the exemplary angle ["front-wearing-mens","front-wearing-ladies"]
humanizeName string descriptive label for Item, displayed on the screen "スタンダードTシャツ"
iconUrls object URLs of item icon {"png":"/assets/items/t-shirt.png"}
id integer unique identifier of Item 1
imageDescriptions array image descriptions on product page ["","","男性モデル: 179cm","女性モデル: 163cm"]
isEmbroidery boolean the item is embroidery or not true
isMultiPrintable boolean the item has two or more printable places or not true
name string unique name of Item "t-shirt"
printPlaceDisplayNames object descriptive names for each print places {"front":"前面","back":"背面"}
printPlaceForExtraAngles object {"t-shirt":{"front-wearing-mens":"front","front-wearing-ladies":"front"}}
productImageUrlTemplates object URL templates of product image for each angles {"front":"https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}\u0026printed={printed}"}
wearingImageUrls object URLs of wearing item {"png":"/assets/wearing_by_item/t-shirt.png"}

Item List

Details

get all Item list

GET /api/v1/items

Curl Example

$ curl -n /api/v1/items

Response Example

HTTP/1.1 200 OK

{
  "items": [
    {
      "id": 1,
      "name": "t-shirt",
      "angles": [
        1
      ],
      "humanizeName": "スタンダードTシャツ",
      "availablePrintPlaces": [
        "front",
        "back"
      ],
      "defaultPrintPlace": "front",
      "displayOrder": 9,
      "essentialAngles": [
        "front",
        "back"
      ],
      "extraAngles": [
        "front-wearing-mens",
        "front-wearing-ladies"
      ],
      "iconUrls": {
        "png": "/assets/items/t-shirt.png"
      },
      "wearingImageUrls": {
        "png": "/assets/wearing_by_item/t-shirt.png"
      },
      "isMultiPrintable": true,
      "printPlaceDisplayNames": {
        "front": "前面",
        "back": "背面"
      },
      "printPlaceForExtraAngles": {
        "t-shirt": {
          "front-wearing-mens": "front",
          "front-wearing-ladies": "front"
        }
      },
      "imageDescriptions": [
        "",
        "",
        "男性モデル: 179cm",
        "女性モデル: 163cm"
      ],
      "productImageUrlTemplates": {
        "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
      },
      "variants": [
        {
          "id": 1,
          "price": 2080,
          "exemplary": true,
          "enabled": true,
          "isLightColor": true,
          "isDarkColor": true,
          "color": {
            "id": 1,
            "name": "white",
            "displayName": "ホワイト",
            "rgb": "#ffffff"
          },
          "size": {
            "id": 1,
            "name": "s",
            "displayName": "S"
          },
          "printPlaces": [
            {
              "id": 1,
              "place": "front",
              "price": 500,
              "itemVariantId": 2
            }
          ],
          "priceWithTax": 2288
        }
      ],
      "isEmbroidery": true,
      "category": {
        "name": "t-shirts",
        "displayName": "Tシャツ（メンズ・レディース）"
      },
      "minPriceWithTax": 1760,
      "colorsCount": 10
    }
  ]
}

Item color

Item color

Attributes

Details

Name Type Description Example
displayName string human readable name of item color "ホワイト"
id integer unique identifier of item color 1
name string unique name of item color "white"
rgb string rgb color of item color "#ffffff"

Item size

item size

Attributes

Details

Name Type Description Example
displayName string human readable name of item size "S"
id integer unique identifier of item size 1
name string unique name of item size "s"

Item variant

combination of Item Color & Item Size.

Attributes

Details

Name Type Description Example
color:displayName string human readable name of item color "ホワイト"
color:id integer unique identifier of item color 1
color:name string unique name of item color "white"
color:rgb string rgb color of item color "#ffffff"
enabled boolean flag of enabled or not true
exemplary boolean flag of exemplary or not (if variant was exemplary, that is used for SUZURI\'s products list page) true
id integer unique identifier of item_variant 1
isDarkColor boolean flag of dark color or not true
isLightColor boolean flag of light color or not true
price integer price of item_variant 2080
priceWithTax integer price with tax of item_variant 2288
printPlaces array [{"id":1,"place":"front","price":500,"itemVariantId":2}]
size:displayName string human readable name of item size "S"
size:id integer unique identifier of item size 1
size:name string unique name of item size "s"

Material

Material is a material for create Product. Material is generated from image file uploaded by User

Attributes

Details

Name Type Description Example
description nullable string description of Material "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah."
dominantRgb nullable string dominant color RGB of material "#ffffff"
id integer unique identifier of Material 31106
originalHeight integer original height of Material 1080
originalWidth integer original width of Material 1920
price integer price of Material (will be added to the price of item variant) 100
priceWithTax integer tax included price of Material 110
published boolean true when the material go be published true
publishedAt nullable date-time when material was published "2014-05-07 11:05:25 +0900"
title string title of Material "AAスリスリくん"
uploadedAt date-time when material was uploaded "2014-05-07 11:03:15 +0900"
user:avatarUrl nullable string url avatar image of User "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
user:displayName nullable string descriptive label for User, displayed on the screen "忍者スリスリくん"
user:id integer unique identifier of User 1
user:name string unique name of User "surisurikun"
violation boolean true when the material go violate the rules false

Material List

Details

get Material list

GET /api/v1/materials

Optional Parameters

Name Type Description Example
limit string limit of Materials list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
offset string offset of Materials list pattern: [0-9][0-9]*$ 100
userId string filtering list by User id of Material owner pattern: [1-9][0-9]*$ 2

Curl Example

$ curl -n /api/v1/materials
 -G \
  -d limit=30 \
  -d offset=100 \
  -d userId=2

Response Example

HTTP/1.1 200 OK

{
  "materials": [
    {
      "id": 31106,
      "title": "AAスリスリくん",
      "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
      "price": 100,
      "priceWithTax": 110,
      "violation": false,
      "published": true,
      "publishedAt": "2014-05-07 11:05:25 +0900",
      "uploadedAt": "2014-05-07 11:03:15 +0900",
      "dominantRgb": "#ffffff",
      "originalWidth": 1920,
      "originalHeight": 1080,
      "user": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Material Create

Details

create Material & Products by from image

POST /api/v1/materials

Required Parameters

Name Type Description Example
texture string url of texture image of material (data uri is OK) "https://41.media.tumblr.com/QA9JpdgnOc8ov98s1C4S5EjJ_500.jpg"
title string title of Material "AAスリスリくん"

Optional Parameters

Name Type Description Example
description nullable string description of Material "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah."
price integer price of Material (will be added to the price of item variant) 100
products/exemplaryItemVariantId integer id of Item variant of Product 151
products/itemId integer id of Item of Product 1
products/published boolean if you publish Product, turn this field true true
products/resizeMode nullable string resize mode of material "contain"
products/sub_materials/enabled boolean if you enable SubMaterial, turn this field true true
products/sub_materials/printSide string print side of SubMaterial "back"
products/sub_materials/texture string url of texture image of material (data uri is OK) "https://41.media.tumblr.com/QA9JpdgnOc8ov98s1C4S5EjJ_500.jpg"

Curl Example

$ curl -n -X POST /api/v1/materials \
  -d '{
  "texture": "https://41.media.tumblr.com/QA9JpdgnOc8ov98s1C4S5EjJ_500.jpg",
  "title": "AAスリスリくん",
  "price": 100,
  "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
  "products": [
    {
      "itemId": 1,
      "exemplaryItemVariantId": 151,
      "published": true,
      "resizeMode": "contain",
      "sub_materials": [
        {
          "texture": "https://41.media.tumblr.com/QA9JpdgnOc8ov98s1C4S5EjJ_500.jpg",
          "printSide": "back",
          "enabled": true
        }
      ]
    }
  ]
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "material": {
    "id": 31106,
    "title": "AAスリスリくん",
    "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
    "price": 100,
    "priceWithTax": 110,
    "violation": false,
    "published": true,
    "publishedAt": "2014-05-07 11:05:25 +0900",
    "uploadedAt": "2014-05-07 11:03:15 +0900",
    "dominantRgb": "#ffffff",
    "originalWidth": 1920,
    "originalHeight": 1080,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  },
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ]
}

Material Update

Details

Update Material information

PUT /api/v1/materials/{material_id}

Optional Parameters

Name Type Description Example
description nullable string description of Material "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah."
price integer price of Material (will be added to the price of item variant) 100
products/exemplaryItemVariantId integer id of Item variant of Product 151
products/itemId integer id of Item of Product 1
products/published boolean if you publish product, turn this field true true
products/resizeMode nullable string resize mode of material "contain"
title string title of Material "AAスリスリくん"

Curl Example

$ curl -n -X PUT /api/v1/materials/$MATERIAL_ID \
  -d '{
  "title": "AAスリスリくん",
  "price": 100,
  "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
  "products": [
    {
      "itemId": 1,
      "exemplaryItemVariantId": 151,
      "published": true,
      "resizeMode": "contain"
    }
  ]
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "material": {
    "id": 31106,
    "title": "AAスリスリくん",
    "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
    "price": 100,
    "priceWithTax": 110,
    "violation": false,
    "published": true,
    "publishedAt": "2014-05-07 11:05:25 +0900",
    "uploadedAt": "2014-05-07 11:03:15 +0900",
    "dominantRgb": "#ffffff",
    "originalWidth": 1920,
    "originalHeight": 1080,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  },
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ]
}

Material Delete

Details

Delete Material

DELETE /api/v1/materials/{material_id}

Curl Example

$ curl -n -X DELETE /api/v1/materials/$MATERIAL_ID \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 204 No Content

レスポンスヘッダのみ返します

Material Text

Details

create Material & t-shirt by from text

POST /api/v1/materials/text

Required Parameters

Name Type Description Example
text string text which will made material "AAスリスリくん"

Optional Parameters

Name Type Description Example
itemVariantId integer One product will be made from this item variant 1

Curl Example

$ curl -n -X POST /api/v1/materials/text \
  -d '{
  "text": "AAスリスリくん",
  "itemVariantId": 1
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "material": {
    "id": 31106,
    "title": "AAスリスリくん",
    "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
    "price": 100,
    "priceWithTax": 110,
    "violation": false,
    "published": true,
    "publishedAt": "2014-05-07 11:05:25 +0900",
    "uploadedAt": "2014-05-07 11:03:15 +0900",
    "dominantRgb": "#ffffff",
    "originalWidth": 1920,
    "originalHeight": 1080,
    "user": {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
    }
  },
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ]
}

print location of item

Attributes

Details

Name Type Description Example
id integer unique identifier of print place 1
itemVariantId integer unique id of associated item vriant 2
place string name of print place "front"
price integer price price for this place 500

Product

Product created from Material

Attributes

Details

Name Type Description Example
createdAt date-time when product was created "2015-01-14 11:58:29 +0900"
discountedPriceWithTax integer discounted product price with tax 2288
examplaryAngle nullable string exemplary angle of products (which is used for SUZURI web page) "back"
id integer unique identifier of product 1
imageUrl string url of product image (we have to fix where enclosed by \'{}\') "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b"
item:angles array angles of Item (used when generate item image) [1]
item:availablePrintPlaces array printable places ["front","back"]
item:defaultPrintPlace string print place which is selected as exemplary by default "front"
item:displayOrder integer sort order for displaying items list 9
item:essentialAngles array angles that can be selected as the examplary angle ["front","back"]
item:extraAngles array angles that cannot be selected as the exemplary angle ["front-wearing-mens","front-wearing-ladies"]
item:humanizeName string descriptive label for Item, displayed on the screen "スタンダードTシャツ"
item:iconUrls object URLs of item icon {"png":"/assets/items/t-shirt.png"}
item:id integer unique identifier of Item 1
item:imageDescriptions array image descriptions on product page ["","","男性モデル: 179cm","女性モデル: 163cm"]
item:isEmbroidery boolean the item is embroidery or not true
item:isMultiPrintable boolean the item has two or more printable places or not true
item:name string unique name of Item "t-shirt"
item:printPlaceDisplayNames object descriptive names for each print places {"front":"前面","back":"背面"}
item:printPlaceForExtraAngles object {"t-shirt":{"front-wearing-mens":"front","front-wearing-ladies":"front"}}
item:productImageUrlTemplates object URL templates of product image for each angles {"front":"https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}\u0026printed={printed}"}
item:wearingImageUrls object URLs of wearing item {"png":"/assets/wearing_by_item/t-shirt.png"}
material:description nullable string description of Material "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah."
material:dominantRgb nullable string dominant color RGB of material "#ffffff"
material:id integer unique identifier of Material 31106
material:originalHeight integer original height of Material 1080
material:originalWidth integer original width of Material 1920
material:price integer price of Material (will be added to the price of item variant) 100
material:priceWithTax integer tax included price of Material 110
material:published boolean true when the material go be published true
material:publishedAt nullable date-time when material was published "2014-05-07 11:05:25 +0900"
material:title string title of Material "AAスリスリくん"
material:uploadedAt date-time when material was uploaded "2014-05-07 11:03:15 +0900"
material:user:avatarUrl nullable string url avatar image of User "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
material:user:displayName nullable string descriptive label for User, displayed on the screen "忍者スリスリくん"
material:user:id integer unique identifier of User 1
material:user:name string unique name of User "surisurikun"
material:violation boolean true when the material go violate the rules false
priceWithTax integer product price with tax 2080
published boolean if product is published, this is true true
publishedAt nullable date-time when product was published "2015-01-14 11:58:29 +0900"
sampleImageUrl string sample of image url "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b"
sampleItemVariant:color:displayName string human readable name of item color "ホワイト"
sampleItemVariant:color:id integer unique identifier of item color 1
sampleItemVariant:color:name string unique name of item color "white"
sampleItemVariant:color:rgb string rgb color of item color "#ffffff"
sampleItemVariant:enabled boolean flag of enabled or not true
sampleItemVariant:exemplary boolean flag of exemplary or not (if variant was exemplary, that is used for SUZURI\'s products list page) true
sampleItemVariant:id integer unique identifier of item_variant 1
sampleItemVariant:isDarkColor boolean flag of dark color or not true
sampleItemVariant:isLightColor boolean flag of light color or not true
sampleItemVariant:price integer price of item_variant 2080
sampleItemVariant:priceWithTax integer price with tax of item_variant 2288
sampleItemVariant:printPlaces array [{"id":1,"place":"front","price":500,"itemVariantId":2}]
sampleItemVariant:size:displayName string human readable name of item size "S"
sampleItemVariant:size:id integer unique identifier of item size 1
sampleItemVariant:size:name string unique name of item size "s"
sampleUrl string sample of url "https://suzuri.jp/surisurikun/31106/t-shirt/s/white"
title string title of product "AAスリスリくん スタンダードTシャツ"
updatedAt date-time when product was updated "2015-01-14 11:58:29 +0900"
url string url of product (we have to fix where enclosed by \'{}\') "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}"

Product List

Details

get Product list

GET /api/v1/products

Optional Parameters

Name Type Description Example
itemId string name of Item pattern: [1-9][0-9]*$ 1
limit string limit of Products list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
materialId string filtering list by Material id pattern: [1-9][0-9]*$ 101
offset string offset of Products list pattern: [0-9][0-9]*$ 100
userId string filtering list by User id of Product owner pattern: [1-9][0-9]*$ 2
userName string filtering list by User name of Product owner pattern: [\w-]*$ "surisurikun"

Curl Example

$ curl -n /api/v1/products
 -G \
  -d itemId=1 \
  -d limit=30 \
  -d offset=100 \
  -d userId=2 \
  -d userName=surisurikun \
  -d materialId=101

Response Example

HTTP/1.1 200 OK

{
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Product Choice product list

Details

get Choice product list

GET /api/v1/choices/{choice_id}/products

Optional Parameters

Name Type Description Example
limit string limit of Products list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
offset string offset of Products list pattern: [0-9][0-9]*$ 100

Curl Example

$ curl -n /api/v1/choices/$CHOICE_ID/products
 -G \
  -d limit=30 \
  -d offset=100

Response Example

HTTP/1.1 200 OK

{
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Details

search Product

GET /api/v1/products/search

Optional Parameters

Name Type Description Example
itemId string name of Item pattern: [1-9][0-9]*$ 1
limit string limit of Products list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
offset string offset of Products list pattern: [0-9][0-9]*$ 100
q string search word Length: 0..100 "NINJYA"

Curl Example

$ curl -n /api/v1/products/search
 -G \
  -d limit=30 \
  -d offset=100 \
  -d q=NINJYA \
  -d itemId=1

Response Example

HTTP/1.1 200 OK

{
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Product On Sale

Details

get discounted product list

GET /api/v1/products/on_sale

Optional Parameters

Name Type Description Example
limit string limit of Products list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
offset string offset of Products list pattern: [0-9][0-9]*$ 100

Curl Example

$ curl -n /api/v1/products/on_sale
 -G \
  -d limit=30 \
  -d offset=100

Response Example

HTTP/1.1 200 OK

{
  "products": [
    {
      "id": 1,
      "title": "AAスリスリくん スタンダードTシャツ",
      "published": true,
      "publishedAt": "2015-01-14 11:58:29 +0900",
      "createdAt": "2015-01-14 11:58:29 +0900",
      "updatedAt": "2015-01-14 11:58:29 +0900",
      "examplaryAngle": "back",
      "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
      "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
      "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
      "priceWithTax": 2080,
      "discountedPriceWithTax": 2288,
      "item": {
        "id": 1,
        "name": "t-shirt",
        "angles": [
          1
        ],
        "humanizeName": "スタンダードTシャツ",
        "availablePrintPlaces": [
          "front",
          "back"
        ],
        "defaultPrintPlace": "front",
        "displayOrder": 9,
        "essentialAngles": [
          "front",
          "back"
        ],
        "extraAngles": [
          "front-wearing-mens",
          "front-wearing-ladies"
        ],
        "iconUrls": {
          "png": "/assets/items/t-shirt.png"
        },
        "wearingImageUrls": {
          "png": "/assets/wearing_by_item/t-shirt.png"
        },
        "isMultiPrintable": true,
        "printPlaceDisplayNames": {
          "front": "前面",
          "back": "背面"
        },
        "printPlaceForExtraAngles": {
          "t-shirt": {
            "front-wearing-mens": "front",
            "front-wearing-ladies": "front"
          }
        },
        "imageDescriptions": [
          "",
          "",
          "男性モデル: 179cm",
          "女性モデル: 163cm"
        ],
        "productImageUrlTemplates": {
          "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
        },
        "isEmbroidery": true
      },
      "material": {
        "id": 31106,
        "title": "AAスリスリくん",
        "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
        "price": 100,
        "priceWithTax": 110,
        "violation": false,
        "published": true,
        "publishedAt": "2014-05-07 11:05:25 +0900",
        "uploadedAt": "2014-05-07 11:03:15 +0900",
        "dominantRgb": "#ffffff",
        "originalWidth": 1920,
        "originalHeight": 1080,
        "user": {
          "id": 1,
          "name": "surisurikun",
          "displayName": "忍者スリスリくん",
          "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
        }
      },
      "sampleItemVariant": {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    }
  ],
  "meta": {
    "hasNext": true
  }
}

Product Info

Details

get info for a Product specified by id.

GET /api/v1/products/{product_id}

Curl Example

$ curl -n /api/v1/products/$PRODUCT_ID

Response Example

HTTP/1.1 200 OK

{
  "products": {
    "id": 1,
    "title": "AAスリスリくん スタンダードTシャツ",
    "published": true,
    "publishedAt": "2015-01-14 11:58:29 +0900",
    "createdAt": "2015-01-14 11:58:29 +0900",
    "updatedAt": "2015-01-14 11:58:29 +0900",
    "examplaryAngle": "back",
    "imageUrl": "https://d1q9av5b648rmv.cloudfront.net/{width}x{height}/t-shirt/{size}/{color}[/angle]/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
    "sampleImageUrl": "https://d1q9av5b648rmv.cloudfront.net/1530x1530/t-shirt/s/white/31106/1399428195-2520x2992.png.jpg?h=224855199776d40aa2f7d6e3f181bfb19db9a90b",
    "url": "https://suzuri.jp/surisurikun/31106/t-shirt/{size}/{white}",
    "sampleUrl": "https://suzuri.jp/surisurikun/31106/t-shirt/s/white",
    "item": {
      "id": 1,
      "name": "t-shirt",
      "angles": [
        1
      ],
      "humanizeName": "スタンダードTシャツ",
      "availablePrintPlaces": [
        "front",
        "back"
      ],
      "defaultPrintPlace": "front",
      "displayOrder": 9,
      "essentialAngles": [
        "front",
        "back"
      ],
      "extraAngles": [
        "front-wearing-mens",
        "front-wearing-ladies"
      ],
      "iconUrls": {
        "png": "/assets/items/t-shirt.png"
      },
      "wearingImageUrls": {
        "png": "/assets/wearing_by_item/t-shirt.png"
      },
      "isMultiPrintable": true,
      "printPlaceDisplayNames": {
        "front": "前面",
        "back": "背面"
      },
      "printPlaceForExtraAngles": {
        "t-shirt": {
          "front-wearing-mens": "front",
          "front-wearing-ladies": "front"
        }
      },
      "imageDescriptions": [
        "",
        "",
        "男性モデル: 179cm",
        "女性モデル: 163cm"
      ],
      "productImageUrlTemplates": {
        "front": "https://dp3obxrw75ln8.cloudfront.net/v3/{width}x{height}/t-shirt/{size}/{color}[/angle]/{filePath}[.{adjustment}].{ext}?h={hash}&printed={printed}"
      },
      "isEmbroidery": true
    },
    "material": {
      "id": 31106,
      "title": "AAスリスリくん",
      "description": "cjdiaosjdadfv:::surisurikun:::jaifiavdaiovfhaidhviwefoiah.",
      "price": 100,
      "priceWithTax": 110,
      "violation": false,
      "published": true,
      "publishedAt": "2014-05-07 11:05:25 +0900",
      "uploadedAt": "2014-05-07 11:03:15 +0900",
      "dominantRgb": "#ffffff",
      "originalWidth": 1920,
      "originalHeight": 1080,
      "user": {
        "id": 1,
        "name": "surisurikun",
        "displayName": "忍者スリスリくん",
        "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
      }
    },
    "itemVariants": [
      {
        "id": 1,
        "price": 2080,
        "exemplary": true,
        "enabled": true,
        "isLightColor": true,
        "isDarkColor": true,
        "color": {
          "id": 1,
          "name": "white",
          "displayName": "ホワイト",
          "rgb": "#ffffff"
        },
        "size": {
          "id": 1,
          "name": "s",
          "displayName": "S"
        },
        "printPlaces": [
          {
            "id": 1,
            "place": "front",
            "price": 500,
            "itemVariantId": 2
          }
        ],
        "priceWithTax": 2288
      }
    ],
    "sampleItemVariant": {
      "id": 1,
      "price": 2080,
      "exemplary": true,
      "enabled": true,
      "isLightColor": true,
      "isDarkColor": true,
      "color": {
        "id": 1,
        "name": "white",
        "displayName": "ホワイト",
        "rgb": "#ffffff"
      },
      "size": {
        "id": 1,
        "name": "s",
        "displayName": "S"
      },
      "printPlaces": [
        {
          "id": 1,
          "place": "front",
          "price": 500,
          "itemVariantId": 2
        }
      ],
      "priceWithTax": 2288
    }
  }
}

Profile

user profile

Attributes

Details

Name Type Description Example
body nullable string profile description "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？"
headerUrl nullable string url of header image of user\'s profile page "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
url nullable string user\'s web page "https://suzuri.jp/"

Promotion

LP and sale information posted on top page

Attributes

Details

Name Type Description Example
category string category of Promotion "lp"
id integer unique identifier of Promotion 1
name string name of Promotion "jet-cap-sale"
url string url of Promotion "https://suzuri.jp/lp/five-panel-cap"

User

User is a Suzuri User.

Attributes

Details

Name Type Description Example
avatarUrl nullable string url avatar image of User "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488"
displayName nullable string descriptive label for User, displayed on the screen "忍者スリスリくん"
id integer unique identifier of User 1
identities array auth providers [{"id":1,"provider":"twitter","uid":1181557592,"nickname":"surisurikun","url":"https://twitter.com/surisurikun"}]
name string unique name of User "surisurikun"
official boolean user official flag true
profile:body nullable string profile description "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？"
profile:headerUrl nullable string url of header image of user\'s profile page "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
profile:url nullable string user\'s web page "https://suzuri.jp/"

User List

Details

get User list

GET /api/v1/users

Optional Parameters

Name Type Description Example
limit string limit of User list (default 20) pattern: [1-9]|[1-4][0-9]|50$ 30
name string name of User pattern: [\w-]*$ "surisurikun"
offset string offset of User list pattern: [0-9][0-9]*$ 100

Curl Example

$ curl -n /api/v1/users
 -G \
  -d name=surisurikun \
  -d limit=30 \
  -d offset=100

Response Example

HTTP/1.1 200 OK

{
  "users": [
    {
      "id": 1,
      "name": "surisurikun",
      "displayName": "忍者スリスリくん",
      "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
      "profile": {
        "url": "https://suzuri.jp/",
        "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
        "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
      },
      "identities": [
        {
          "id": 1,
          "provider": "twitter",
          "uid": 1181557592,
          "nickname": "surisurikun",
          "url": "https://twitter.com/surisurikun"
        }
      ],
      "official": true
    }
  ],
  "meta": {
    "hasNext": true
  }
}

User Info

Details

Info for existing User.

GET /api/v1/users/{user_id}

Curl Example

$ curl -n /api/v1/users/$USER_ID

Response Example

HTTP/1.1 200 OK

{
  "user": {
    "id": 1,
    "name": "surisurikun",
    "displayName": "忍者スリスリくん",
    "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
    "profile": {
      "url": "https://suzuri.jp/",
      "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
      "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
    },
    "identities": [
      {
        "id": 1,
        "provider": "twitter",
        "uid": 1181557592,
        "nickname": "surisurikun",
        "url": "https://twitter.com/surisurikun"
      }
    ],
    "official": true
  }
}

User self

Details

Info for authorized User

GET /api/v1/user

Curl Example

$ curl -n /api/v1/user

Response Example

HTTP/1.1 200 OK

{
  "user": {
    "id": 1,
    "email": "hoge@suzuri.jp",
    "name": "surisurikun",
    "displayName": "忍者スリスリくん",
    "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
    "profile": {
      "url": "https://suzuri.jp/",
      "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
      "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
    },
    "identities": [
      {
        "id": 1,
        "provider": "twitter",
        "uid": 1181557592,
        "nickname": "surisurikun",
        "url": "https://twitter.com/surisurikun"
      }
    ],
    "official": true
  }
}

User update

Details

update authorized User

PUT /api/v1/user

Curl Example

$ curl -n -X PUT /api/v1/user \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

{
  "user": {
    "id": 1,
    "name": "surisurikun",
    "displayName": "忍者スリスリくん",
    "avatarUrl": "https://dp3obxrw75ln8.cloudfront.net/users/avatars/7.png?1395818488",
    "profile": {
      "url": "https://suzuri.jp/",
      "body": "こんにちは！SUZURI の公式忍者・スリスリくんです。\\nキミも忍者にならないか？",
      "headerUrl": "https://dp3obxrw75ln8.cloudfront.net/profiles/headers/10.png?1398245916"
    },
    "identities": [
      {
        "id": 1,
        "provider": "twitter",
        "uid": 1181557592,
        "nickname": "surisurikun",
        "url": "https://twitter.com/surisurikun"
      }
    ],
    "official": true
  }
}