Skip to content
Download OpenAPI description
Languages
Servers
Mock server

https://apidoc.printio.me/_mock/printio-api/

公開テスト環境

https://apitest.printio.me/external/

Operations

Request

検索条件に合致する対象リテーラーが作成したオリジナルアイテムの一覧を取得する

Query
retailer_idintegerrequired

リテイラー毎に割り振られる一意な値

Example: retailer_id=1
original_item_codestring

オリジナルアイテム作成時に発行されるコード

Example: original_item_code=t0100001
ec_original_item_codestring

EC側で管理するオリジナルアイテムコード

Example: ec_original_item_code=ORGI00001
category_idinteger

カテゴリーID

Example: category_id=10
item_codestring

アイテムコード

Example: item_code=OGB-910
sort_valuestring

指定された値の項目の昇順でソートされる。利用可能な値はoriginal_item_name, created_atのみ。

Default "created_at"
Example: sort_value=original_item_name
limitinteger[ 1 .. 30 ]

1ページでの最大取得件数

Default 25
Example: limit=10
pageinteger>= 1

ページ

Default 1
Example: page=1
team_idinteger

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

Example: team_id=1
Headers
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

curl -i -X GET \
  'https://apidoc.printio.me/_mock/printio-api/original-items?retailer_id=1&original_item_code=t0100001&ec_original_item_code=ORGI00001&category_id=10&item_code=OGB-910&sort_value=original_item_name&limit=10&page=1&team_id=1' \
  -H 'Accept: application/json' \
  -H 'Printio-Api-Subscription-Key: string'

Responses

Bodyapplication/json
original_itemsArray of objects(オリジナルアイテム)required
original_items[].​original_item_codestring(オリジナルアイテムコード)required

オリジナルアイテム作成時に発行されるコード

original_items[].​ec_original_item_codestring or null(EC側オリジナルアイテムコード)required
original_items[].​retailer_idinteger(リテイラーID)>= 1required
original_items[].​category_idstring(カテゴリーID)required
original_items[].​category_namestring(カテゴリー名)required
original_items[].​item_codestring(アイテムコード)required
original_items[].​image_urlsArray of objects(画像URL)required

オリジナルアイテムの画像URL

original_items[].​image_urls[].​color_namestring(色名)required
original_items[].​image_urls[].​mfr_color_namestring(色名)required
original_items[].​image_urls[].​urlstring(URL)required

オリジナルアイテムのデザイン画像のURL。

original_items[].​original_item_namestring(オリジナルアイテム名)required
original_items[].​item_namestring(アイテム名)required
original_items[].​sizesobject(サイズ)required
original_items[].​sizes.​valuesArray of objects(サイズ値)required
original_items[].​sizes.​values[].​namestring(サイズ名)required
original_items[].​sizes.​values[].​detailsArray of objects(サイズ詳細)required
original_items[].​sizes.​values[].​details[].​namestring(サイズ詳細名)required
original_items[].​sizes.​values[].​details[].​valuestring(サイズ詳細値)required
original_items[].​sizes.​values[].​additional_pricestring(サイズ追加料金)
original_items[].​sizes.​descriptionstring(サイズ説明)
original_items[].​colorsobject(色)required
original_items[].​colors.​valuesArray of objects(色値)
original_items[].​colors.​descriptionstring(色説明)
original_items[].​default_colorobjectrequired

サムネイルのTOP画像に使用する色

original_items[].​default_color.​hexstring(色HEX値)required
original_items[].​default_color.​namestring(色名)required
original_items[].​created_atstring(date-time)(作成日時)required
original_items[].​updated_atstring(date-time)(更新日時)required
totalinteger(検索結果の総数)>= 0required

検索結果の総件数

status_codeinteger(ステータスコード)>= 0required

処理のステータスコード 0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

Response
application/json
{ "original_items": [ {} ], "total": 25, "status_code": 0 }

Request

アイテムの一覧を取得するAPI

Query
category_idinteger

カテゴリーID

Example: category_id=10
item_codestring

アイテムコード

Example: item_code=OGB-910
retailer_idintegerrequired

リテイラーID

Example: retailer_id=1
limitinteger[ 1 .. 30 ]

1ページでの最大取得件数

Default 25
Example: limit=10
pageinteger>= 1

ページ

Default 1
Example: page=1
Headers
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

curl -i -X GET \
  'https://apidoc.printio.me/_mock/printio-api/items?category_id=10&item_code=OGB-910&retailer_id=1&limit=10&page=1' \
  -H 'Accept: application/json' \
  -H 'Printio-Api-Subscription-Key: string'

Responses

Bodyapplication/json
list_item_dataArray of objects(アイテム情報)required
list_item_data[].​codestring(アイテムコード)required
list_item_data[].​item_namestring(アイテム名)required
list_item_data[].​category_idinteger(カテゴリーID)required
list_item_data[].​image_urlsArray of strings( 画像URL)required

アイテム画像のURL(複数)

list_item_data[].​main_image_urlstring(メイン画像URL)required

メイン画像のURL

list_item_data[].​sizesobject(サイズ)required
list_item_data[].​sizes.​valuesArray of objects(サイズ値)required
list_item_data[].​sizes.​values[].​namestring(サイズ名)required
list_item_data[].​sizes.​values[].​detailsArray of objects(サイズ詳細)required
list_item_data[].​sizes.​values[].​details[].​namestring(サイズ詳細名)required
list_item_data[].​sizes.​values[].​details[].​valuestring(サイズ詳細値)required
list_item_data[].​sizes.​values[].​additional_pricestring(サイズ追加料金)
list_item_data[].​sizes.​descriptionstring(サイズ説明)
list_item_data[].​colorsobject(色)required
list_item_data[].​colors.​valuesArray of objects(色値)
list_item_data[].​colors.​descriptionstring(色説明)
list_item_data[].​pricenumber(価格)required

1点あたりの価格

list_item_data[].​descriptionstring(説明)required

アイテムの説明

list_item_data[].​detail_descriptionstring(詳細説明)required

アイテムの詳細な説明

list_item_data[].​cautionsstring(注意書き)required
list_item_data[].​display_unitstring(表示単位)required
list_item_data[].​simulator_typeobject(%E3%82%B7%E3%83%9F%E3%83%A5%E3%83%AC%E3%83%BC%E3%82%BF%E3%83%BC.%E7%94%BB%E5%83%8F%E3%82%B5%E3%82%A4%E3%82%BA)required
list_item_data[].​simulator_type.​image_sizeobject(画像サイズ)required
list_item_data[].​simulator_type.​image_size.​valuesArray of objectsrequired
list_item_data[].​simulator_type.​image_size.​values[].​namestring(サイズ名)required

widthまたはheight

list_item_data[].​simulator_type.​image_size.​values[].​mm_sizestring(mmサイズ)required
list_item_data[].​simulator_type.​image_size.​values[].​px_sizestring(ピクセルサイズ)required
list_item_data[].​simulator_type.​dpiinteger(印刷時の解像度)

デフォルトは200

totalinteger(検索結果の総数)required

検索結果の総件数

status_codeinteger(ステータスコード)required

処理のステータスコード 0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

messagestring(メッセージ)required

処理のメッセージ

Response
application/json
{ "list_item_data": [ {} ], "total": 1, "status_code": 0, "message": "成功しました。" }

ユーザーチーム取得API(テスト公開中)

Request

テスト公開中 メールアドレスを指定してユーザーチーム情報を取得する ※Printio内部で利用可能なAPIです。リテイラー様は通常ご利用いただけません。

Query
retailer_idintegerrequired

リテイラーID

Example: retailer_id=1
Headers
MailAddressstring

ユーザーのメールアドレス

Printio-Api-Subscription-Keystring

APIキー

curl -i -X GET \
  'https://apidoc.printio.me/_mock/printio-api/users/user?retailer_id=1' \
  -H 'MailAddress: string' \
  -H 'Printio-Api-Subscription-Key: string'

Responses

Bodyapplication/json
responseobjectrequired
response.​is_user_existsboolean(ユーザーが存在するか否か)required
response.​user_infoobject or null(ユーザー情報)
status_codeinteger(ステータス)required

処理のステータスコード 0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

messagestring(メッセージ)required

処理のメッセージ

Response
application/json
{ "response": { "is_user_exists": true, "user_info": {} }, "status_code": 0, "message": "成功しました。" }

Request

オリジナルアイテムコードを指定して発注するAPI

Headers
Content-Typestring
Example: application/json
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

X-Feature-Flagsstring

拡張機能を有効化する場合に設定する MultiItemOrder: 1回のリクエストで複数種類のアイテムを注文できるようにするモード リクエストボディの注文詳細(order_details)に、異なるオリジナルアイテムコード(original_item_code)のデータを設定できるようになります。 また、在庫エラー時には、エラーの詳細情報をレスポンスに含むようになります。

Example: MultiItemOrder
Bodyapplication/json
retailer_idinteger(リテイラーID)>= 1required

Ec連携先に付与するID

team_idstring(チームID)

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

ec_order_nostring(EC側注文番号)<= 50 charactersrequired

Ec連携先での注文番号

ec_order_datestring(EC側注文日)

Ec連携先での注文日

shipping_informationobject(配送先情報)required

配送伝票の配送先の情報

shipping_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

shipping_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

shipping_information.​municipalitiesstring(市区町村)required
shipping_information.​address1string(住所1行目)required

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

shipping_information.​address2string(住所2行目)

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

shipping_information.​full_namestring(氏名)required
shipping_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

shipping_information.​mail_addressstring or null(メールアドレス)

正しいメールアドレス形式で指定

sender_informationobject(送り主情報)required

配送伝票の送り主の情報

sender_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

sender_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

sender_information.​municipalitiesstring(市区町村)required
sender_information.​address1string(住所1行目)required

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

sender_information.​address2string(住所2行目)

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

sender_information.​full_namestring(氏名)required
sender_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

sender_information.​mail_addressstring or null(メールアドレス)

正しいメールアドレス形式で指定

sender_information.​item_namestring(品名)required

配送伝票の品名に使用する

order_detailsArray of objectsrequired

注文明細

order_details[].​ec_order_detail_nostring(EC側注文明細番号)<= 50 characters

EC側注文明細番号

order_details[].​original_item_codestring(オリジナルアイテムコード)

ec_original_item_codeが設定されていない場合は必須

order_details[].​ec_original_item_codestring(ECオリジナルアイテムコード)

original_item_codeが設定されていない場合は必須

order_details[].​quantityinteger(数量)>= 1required
order_details[].​colorstring(色名)required
order_details[].​sizestring(サイズ)required
ec_optional_informationstring(EC側オプション情報)

EC側の任意の情報。注文ステータス取得APIでそのまま返される。

Example: "春のキャンペーン"
action_after_printobject

印刷後の特別対応を指示するパラメータ

shipping_methodinteger(配送方法)

配送方法を指定する。1:クロネコゆうパケット、2:ヤマト宅急便

curl -i -X POST \
  https://apidoc.printio.me/_mock/printio-api/order-by-code \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -H 'X-Feature-Flags: MultiItemOrder' \
  -d '{
    "retailer_id": 1,
    "ec_order_no": "0001",
    "ec_order_date": "2024-06-01",
    "shipping_information": {
      "zip_code": "5551701",
      "prefecture_name": "東京都",
      "municipalities": "千代田区",
      "address1": "912 心愛Estate",
      "address2": "Suite 510",
      "full_name": "山田 正",
      "phone_number": "0802254334",
      "mail_address": "tsubasasuzuki@gmail.com"
    },
    "sender_information": {
      "zip_code": "2278756",
      "prefecture_name": "愛媛県",
      "municipalities": "八幡浜市",
      "address1": "松本107",
      "address2": "Apt. 713",
      "full_name": "山本 佳奈",
      "phone_number": "0938757974",
      "mail_address": "aozora20@hotmail.com",
      "item_name": "オリジナルアイテム"
    },
    "order_details": [
      {
        "ec_order_detail_no": "0001-01",
        "original_item_code": "t0100001",
        "quantity": 1,
        "color": "natural cotton",
        "size": "S"
      },
      {
        "ec_order_detail_no": "0001-02",
        "ec_original_item_code": "ORGI000001",
        "quantity": 2,
        "color": "natural cotton",
        "size": "M"
      }
    ],
    "ec_optional_information": "キャンペーン対象注文",
    "action_after_print": {
      "novelty": {
        "ノベルティ1": 1,
        "ノベルティ2": 0
      }
    },
    "shipping_method": 1
  }'

Responses

Bodyapplication/json
responseobject(レスポンス)required
response.​order_nostring(注文番号)

注文の登録が成功した場合に設定される

response.​ec_order_nostring(EC側注文番号)required

注文の登録の成否にかかわらず設定される

response.​status_codeinteger(ステータスコード)>= 1required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、13:在庫なしエラー、14:決済エラー、それ以外:システムエラー

Enum015111314"その他"
response.​messagestring(メッセージ)required

処理のステータスコードを補足する情報

response.​available_itemsArray of objects(注文可能アイテム情報)

拡張機能:MultiItemOrderモードで在庫エラーの際に設定される

Response
application/json
{ "response": { "order_no": "2405000013", "ec_order_no": "0001", "status_code": 0, "message": "成功しました。" } }

Request

PrintioシミュレーターのURLを取得する。

Headers
Content-Typestring
Example: application/json
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

Bodyapplication/json
retailer_idinteger(リテイラーID)>= 1required
previous_urlstring(前URL)required

シミュレータ内「戻る」ボタンの遷移先

next_urlstring(次URL)required

シミュレータ内「デザイン完了」ボタンの遷移先

team_idinteger(チームID)

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

item_codestring

アイテムコード item_idを指定しない場合は必須

user_idinteger(ユーザーID)

一部のリテイラー様のみ利用可

item_idinteger(アイテムID)Deprecated

一部のリテイラー様のみ利用可

curl -i -X POST \
  https://apidoc.printio.me/_mock/printio-api/simulator-url \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -d '{
    "retailer_id": 1,
    "previous_url": "https://actual-bifocals.net",
    "next_url": "http://spotted-gym.info",
    "item_code": "OGB-910"
  }'

Responses

Bodyapplication/json
responseobject(レスポンス)required
response.​simulator_urlstring(シミュレータURL)

シミュレータURL。成功した場合にセットされる。

response.​messagestring(メッセージ)required

処理のステータスコードを補足する情報

response.​status_codeinteger(ステータスコード)required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

Enum01511"その他"
Response
application/json
{ "response": { "simulator_url": "http://filthy-volcano.net", "message": "成功しました。", "status_code": 0 } }

Request

オリジナルアイテムを作成するAPI

Headers
Content-Typestring
Example: application/json
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

Bodyapplication/json
retailer_idinteger(リテイラーID)>= 1required

Ec連携先に付与するID

item_codestring(アイテムコード)required

アイテムを識別するコード

Example: "OGB-910"
ec_original_item_codestring(EC側オリジナルアイテムコード)<= 50 characters

EC側でオリジナルアイテムを識別するコード

Example: "ORGI000001"
original_item_namestring(オリジナルアイテム名)<= 255 characters

作成するオリジナルアイテムの名前

Example: "Tシャツ2025夏"
image_urlsArray of objects(画像URL)required

オリジナルアイテムとして作成する画像のURL

image_urls[].​positionstring(画像を配置する場所)required

当面は"front"のみ指定可能

Example: "front"
image_urls[].​urlstring(画像のURL)required

指定可能なファイル形式は、png、jpg、pdf

Example: "https://printio-api.png"
paramsobject(編集・配置用のパラメータ)

当面は無視される

team_idinteger(チームID)>= 1

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

user_idinteger(ユーザーID)>= 1

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

curl -i -X POST \
  https://apidoc.printio.me/_mock/printio-api/original-item \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -d '{
    "retailer_id": 1,
    "item_code": "OGB-910",
    "original_item_name": "Tシャツ2025夏",
    "image_urls": [
      {
        "position": "front",
        "url": "https://printio-api.png"
      }
    ],
    "team_id": 1,
    "user_id": 1
  }'

Responses

Bodyapplication/json
responseobject(レスポンス)required
response.​original_item_codestring(オリジナルアイテムコード)required

登録が成功した場合に設定される

Example: "t0100001"
response.​ec_original_item_codestring(EC側オリジナルアイテムコード)required

登録の成否にかかわらず設定される

Example: "ORGI000001"
response.​status_codeinteger(ステータスコード)required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、15:重複エラー、それ以外:システムエラー

Enum0151115"その他"
Example: 1
response.​messagestring(メッセージ)required

処理のステータスコードを補足する情報

Response
application/json
{ "response": { "original_item_code": "t0100001", "ec_original_item_code": "ORGI000001", "status_code": 0, "message": "成功しました。" } }

Request

注文情報を取得するAPI

Query
order_nostring

printioの注文番号で取得する場合に指定する。カンマ区切りで複数指定可能。このパラメータが指定された場合には、他のパラメータは無視される

Example: order_no=2405000013,2405000013
ec_order_nostring

EC側注文番号で取得する場合に指定する 。order_noパラメータが指定されず、このパラメータが指定された場合には、他のパラメータは無視される。

status_idinteger

取得する注文のステータスIDを特定する場合に指定する。このステータスはAPI処理時点でのステータスとなる。

Example: status_id=100
date_time_fromstring

取得する注文が登録された日時の範囲のFROMを指定する。 order_no, ec_order_noが指定されていない場合には必須指定。

Example: date_time_from=2024-05-27 19:39:31
date_time_tostring

取得する注文が登録された日時の範囲のTOを指定する。

Example: date_time_to=2024-05-27 19:39:31
sort_valuestring

ソートする値の指定。利用可能な値はstatus_id,created_at。

Example: sort_value=status_id
orderstring

並び順の指定。利用可能な値はasc,descのみ。

Default "昇順"
Enum"asc""desc"
Example: order=asc
team_idinteger

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

limitinteger[ 1 .. 30 ]

1ページでの最大取得件数

Default 25
Example: limit=10
pageinteger>= 1

ページ指定

Default 1
Example: page=1
Headers
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

X-Feature-Flagsstring

拡張機能を有効化する場合に設定する MultiItemOrder: 複数種類のアイテムを同時に注文可能になるモード レスポンスに配送IDが追加され、同じ注文番号のデータが複数件設定されるようになります 設定例: ①注文番号:1000,配送ID:01 ②注文番号:1000,配送ID:02

Example: MultiItemOrder
curl -i -X GET \
  'https://apidoc.printio.me/_mock/printio-api/orders?order_no=2405000013%2C2405000013&ec_order_no=string&status_id=100&date_time_from=2024-05-27+19%3A39%3A31&date_time_to=2024-05-27+19%3A39%3A31&sort_value=status_id&order=asc&team_id=0&limit=10&page=1' \
  -H 'Accept: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -H 'X-Feature-Flags: MultiItemOrder'

Responses

Bodyapplication/json
ordersArray of objects(レスポンス)required
orders[].​order_nostring(注文番号)required
orders[].​ec_order_nostring or null(EC側注文番号)required
orders[].​ec_order_datestring or null(EC側注文日)required
orders[].​shipping_idstring(配送ID)

リクエストヘッダーパラメーターのX-Feature-FlagsにMultiItemOrderが指定されている際に設定されている 配送を識別する値

orders[].​shipping_informationobjectrequired
orders[].​shipping_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

orders[].​shipping_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

orders[].​shipping_information.​municipalitiesstring(市区町村)required
orders[].​shipping_information.​address1string(住所1行目)required
orders[].​shipping_information.​address2string(住所2行目)
orders[].​shipping_information.​full_namestring(氏名)required
orders[].​shipping_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

orders[].​shipping_information.​mail_addressstring or null(メールアドレス)required

正しいメールアドレス形式で指定

orders[].​sender_informationobjectrequired
orders[].​sender_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

orders[].​sender_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

orders[].​sender_information.​municipalitiesstring(市区町村)required
orders[].​sender_information.​address1string(住所1行目)required
orders[].​sender_information.​address2string(住所2行目)
orders[].​sender_information.​full_namestring(氏名)required
orders[].​sender_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

orders[].​sender_information.​mail_addressstring or null(メールアドレス)required

正しいメールアドレス形式で指定

orders[].​sender_information.​item_namestring(品名)required

配送伝票の品名に使用する

orders[].​order_status_idinteger(注文ステータスID)>= 0required
orders[].​order_status_namestring(注文ステータス名)required
orders[].​scheduled_shipping_datestring(出荷予定日)required
orders[].​shipping_datestring or null(出荷日)required
orders[].​scheduled_delivery_datestring or null(配送予定日)required
orders[].​delivery_company_namestring(配送会社名)
Example: ["ヤマト運輸","佐川急便"]
orders[].​shipping_method_namestring(配送方法名)
Example: ["宅急便","クロネコゆうパケット","飛脚宅配便"]
orders[].​shipping_numberstring or null(配送伝票番号)required
orders[].​order_detailsArray of objects(注文明細)required
orders[].​order_details[].​order_detail_nostring(注文明細番号)required
orders[].​order_details[].​ec_order_detail_nostring or null(EC側注文明細番号)required
orders[].​order_details[].​item_codestring(アイテムコード)required
orders[].​order_details[].​item_namestring(アイテム名)required
orders[].​order_details[].​quantityinteger(数量)>= 1required
orders[].​order_details[].​colorstring(色)required
orders[].​order_details[].​hexstring(色HEX値)required
orders[].​order_details[].​sizestring(サイズ)required
orders[].​order_details[].​order_detail_status_idinteger(注文明細ステータスID)required
orders[].​order_details[].​order_detail_status_namestring(注文明細ステータス名)required
orders[].​order_details[].​item_idstring(アイテムID)Deprecated
orders[].​ec_optional_informationstring or null(EC側オプション情報)required
orders[].​action_after_printobject or null

印刷後の特別対応を指示するパラメータ

totalinteger(総件数)>= 0required

検索に一致したデータの総件数

status_codeinteger(ステータスコード)required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

messagestring(処理のメッセージ)required

処理のメッセージ

Response
application/json
{ "orders": [ {}, {} ], "total": 100, "status_code": 0, "message": "成功しました。" }

Request

注文のステータス情報を取得する

Query
order_nostring

printioの注文番号で取得する場合に指定する 。このパラメータが指定された場合には、他のパラメータは無視される

Example: order_no=240400002101
ec_order_nostring

EC側注文番号で取得する場合に指定する 。 order_noパラメータが指定されず、このパラメータが指定された場合には、他のパラメータは無視される。

status_idinteger

取得する注文のステータスIDを特定する場合に指定する。 このステータスはAPI処理時点でのステータスとなる。 date_time_from, date_time_toとはAND条件となる。

Example: status_id=100
date_time_fromstring

取得する注文のステータスが変更された日時の範囲のFROMを指定する。"order_no, ec_order_noが指定されていない場合には必須指定。 status_id, date_time_toとはAND条件となる。

Example: date_time_from=2024-06-01 00:00:00
date_time_tostring

取得する注文のステータスが変更された日時の範囲のTOを指定する。status_id, date_time_fromとはAND条件となる。

Example: date_time_to=2024-06-02 10:00:00
team_idinteger

Printio内部で利用可能なパラメータです。リテイラー様は通常ご利用いただけません。

Headers
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

X-Feature-Flagsstring

拡張機能を有効化する場合に設定する MultiItemOrder: 複数種類のアイテムを同時に注文可能になるモード レスポンスに配送IDが追加され、同じ注文番号のデータが複数件設定されるようになります 設定例: ①注文番号:1000,配送ID:01 ②注文番号:1000,配送ID:02

Example: MultiItemOrder
curl -i -X GET \
  'https://apidoc.printio.me/_mock/printio-api/order-statuses?order_no=240400002101&ec_order_no=string&status_id=100&date_time_from=2024-06-01+00%3A00%3A00&date_time_to=2024-06-02+10%3A00%3A00&team_id=0' \
  -H 'Accept: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -H 'X-Feature-Flags: MultiItemOrder'

Responses

Bodyapplication/json
ordersArray of objects(レスポンス)required
orders[].​order_nostring(注文番号)required
orders[].​ec_order_nostring or null(EC側注文番号)required
orders[].​shipping_idstring(配送ID)

リクエストヘッダーパラメーターのX-Feature-FlugsにMultiItemOrderが指定されている際に設定されている 配送を識別する値

orders[].​status_idinteger(ステータスID)required
orders[].​status_namestring(ステータス名)required
orders[].​scheduled_shipping_datestring(出荷予定日 )required
orders[].​shipping_datestring or null(出荷日)required
orders[].​scheduled_delivery_datestring or null(配送予定日)required
orders[].​shipping_numberstring or null(配送伝票番号)required
orders[].​updated_atstring(更新日時)required
orders[].​ec_optional_informationstring or null(EC側オプション情報)required
status_codeinteger(ステータスコード)required

処理のステータスコード、詳細:0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

Response
application/json
{ "orders": [ {}, {}, {} ], "status_code": 0 }

Request

画像を指定して新規注文を登録する

Headers
Content-Typestring
Example: application/json
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

X-Feature-Flagsstring

拡張機能を有効化する場合に設定する MultiItemOrder: 1回のリクエストで複数種類のアイテムを注文できるようにするモード → リクエストボディの注文詳細(order_details)に、異なるオリジナルアイテムコード(original_item_code)のデータを設定できるようになります。

Example: MultiItemOrder
Bodyapplication/json
retailer_idinteger(リテーラーID)required

Ec連携先に付与するID

ec_order_nostring(EC側注文番号)<= 50 charactersrequired

Ec連携先での注文番号

ec_order_datestring or null(EC側注文日)<= 50 charactersrequired

Ec連携先での注文日

shipping_informationobject(配送先情報)required

配送伝票の配送先の情報

shipping_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

shipping_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

shipping_information.​municipalitiesstring(市区町村)required
shipping_information.​address1string(住所1行目)required

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

shipping_information.​address2string(住所2行目)

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

shipping_information.​full_namestring(氏名)required
shipping_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

shipping_information.​mail_addressstring(メールアドレス)

正しいメールアドレス形式で指定

sender_informationobject(送り主情報)required

配送伝票の送り主の情報

sender_information.​zip_codestring(郵便番号)required

"-"なしの数値7桁で指定

sender_information.​prefecture_namestring(都道府県)required

"都", "道", "府", "県"も指定

sender_information.​municipalitiesstring(市区町村)required
sender_information.​address1string(住所1行目)required

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

sender_information.​address2string(住所2行目)

全角16文字/半角32文字まで。超過した部分は切り捨てられる場合があります。

sender_information.​full_namestring(氏名)required
sender_information.​phone_numberstring(電話番号)[ 10 .. 15 ] charactersrequired

"-"なしの数値10から15桁で指定

sender_information.​mail_addressstring(メールアドレス)

正しいメールアドレス形式で指定

sender_information.​item_namestring(品名)required

配送伝票の品名に使用する

order_detailsArray of objects(注文明細 )required
order_details[].​ec_order_detail_nostring(EC側注文明細番号 )<= 50 charactersrequired
order_details[].​item_codestring(アイテムコード )required

設定する値は連携先ユーザー様毎の補足資料参照

order_details[].​quantityinteger(数量 )required
order_details[].​colorstring(色 )required

設定する値は連携先ユーザー様毎の補足資料参照

order_details[].​sizestring(サイズ )required

設定する値は連携先ユーザー様毎の補足資料参照

order_details[].​image_urlsobject(画像URL )required
order_details[].​image_urls.​valuesArray of objects(値 )required
order_details[].​image_urls.​values[].​positionstring(印刷場所 )required

印刷する場所を以下から指定 front/back/left/right、現在はfrontのみ指定可

order_details[].​image_urls.​values[].​urlsArray of objects(URL配列 )required
order_details[].​image_urls.​values[].​urls[].​typestring(画像タイプ )required

画像のタイプを以下から指定 Output/Thumbnail

order_details[].​image_urls.​values[].​urls[].​urlstring(URL )required

画像のURL

ec_optional_informationstring(EC側オプション情報 )

EC側の任意の情報 注文ステータス取得APIでそのまま返される

curl -i -X POST \
  https://apidoc.printio.me/_mock/printio-api/orders/order-with-image \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -H 'X-Feature-Flags: MultiItemOrder' \
  -d '{
    "retailer_id": 1,
    "ec_order_no": "TEST0001",
    "ec_order_date": "2024-06-01",
    "shipping_information": {
      "zip_code": "1230123",
      "prefecture_name": "東京都",
      "municipalities": "千代田区",
      "address1": "神田神保町",
      "address2": "123456",
      "full_name": "千代田民夫",
      "phone_number": "0312345678",
      "mail_address": "printioapi@abcdefg.com"
    },
    "sender_information": {
      "zip_code": "1230123",
      "prefecture_name": "大阪府",
      "municipalities": "富田林市",
      "address1": "千枚田",
      "address2": "11111",
      "full_name": "富田平次",
      "phone_number": "0312345678",
      "mail_address": "printioapi@abcdefg.com",
      "item_name": "作品2024"
    },
    "order_details": [
      {
        "ec_order_detail_no": "",
        "item_code": "OGB-910",
        "quantity": 1,
        "color": "natural cotton",
        "size": "S",
        "image_urls": {
          "values": [
            {
              "position": "front",
              "urls": [
                {
                  "type": "Thumbnail",
                  "url": "http://printioapi/thumbail.png"
                },
                {
                  "type": "Output",
                  "url": "http://printioapi/Output.png"
                }
              ]
            }
          ]
        }
      }
    ],
    "ec_optional_information": ""
  }'

Responses

Bodyapplication/json
responseobject(レスポンス)required
response.​order_nostring(注文番号 )

注文の登録が成功した場合に設定される

response.​ec_order_nostring(EC側注文番号 )required

注文の登録の成否にかかわらず設定される

response.​status_codeinteger(ステータスコード)required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエそれ以外:システムエラー

Enum01511"その他"
response.​messagestring(メッセージ)required

処理のステータスコードを補足する情報

Response
application/json
{ "response": { "order_no": "24000001", "ec_order_no": "TEST0001", "status_code": 0, "message": "成功しました。" } }

Request

アイテムの在庫情報を取得する

Headers
Content-Typestring
Example: application/json
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystring

連携先ユーザー様毎に発行されるAPIキー

Bodyapplication/json
retailer_idinteger(リテイラーID)required

リテイラー毎に割り振られる一意な値

category_idinteger(カテゴリーID)
item_codestring(アイテムコード)
item_stock_codesArray of strings(アイテム在庫コード)
curl -i -X POST \
  https://apidoc.printio.me/_mock/printio-api/item-stocks \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Printio-Api-Subscription-Key: string' \
  -d '{
    "retailer_id": 1,
    "category_id": 1,
    "item_code": "OGB-910",
    "item_stock_codes": [
      "OGB-910::natural_cotton::S"
    ]
  }'

Responses

Bodyapplication/json
item_stocksArray of objects(アイテム在庫情報)required
item_stocks[].​category_idinteger(カテゴリーID)required
item_stocks[].​item_stock_codestring(アイテム在庫コード)required

アイテム在庫を識別するコード

item_stocks[].​color_namestring(色名)required
item_stocks[].​sizestring(サイズ)required
item_stocks[].​is_orderableboolean(在庫状態)required

true:注文可能、false::注文不可

item_stocks[].​stock_quantityinteger or null(在庫数)required

nullの場合は無限在庫

status_codeinteger(ステータスコード)required

処理のステータスコード、0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

messagestring(メッセージ)required

処理の結果メッセージ

Response
application/json
{ "item_stocks": [ {}, {}, {} ], "status_code": 0, "message": "成功しました。" }

Request

カテゴリーを取得するAPI

Headers
Acceptstring
Example: application/json
Printio-Api-Subscription-Keystringrequired

連携先ユーザー様毎に発行されるAPIキー

curl -i -X GET \
  https://apidoc.printio.me/_mock/printio-api/categories \
  -H 'Accept: application/json' \
  -H 'Printio-Api-Subscription-Key: string'

Responses

Bodyapplication/json
categoriesArray of objects(カテゴリーリスト)
status_codeinteger(ステータスコード)required

処理のステータスコード 0:成功、1:データなしエラー、5:リクエストパラメータエラー、11:権限なしエラー、それ以外:システムエラー

messagestring(メッセージ)required

処理のメッセージ

Response
application/json
{ "categories": [ {}, {}, {}, {}, {}, {}, {}, {} ], "status_code": 0, "message": "成功しました。" }