ステッカーミュールAPI

クイックスタート

1. APIキーを生成する

アカウント設定を開き、「ストア設定」でAPIキーを生成してください。キーは一度しか表示されませんので、すぐコピーしてください。

2. APIを呼び出す

キーをベアラートークンとして送信してください。この例では、保存済みのアイテムを注文します。

curl -X POST https://www.stickermule.com/api/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "id": "456", "quantity": 50 }],
    "addressId": "22",
    "paymentId": "7"
  }'

認証

すべてのリクエストには、認証ヘッダーにAPIキーをベアラートークンとして含める必要があります。

Authorization: Bearer YOUR_API_KEY

• APIは個人アカウントでのみ利用可能で、チームアカウントでは利用できません。
• 各アカウントには1つのキーが割り当てられています。新しいキーを生成すると、古いキーは置き換えられます。
• キーはパスワードのように扱ってください。注文や保存データの読み取りに使えます。

ベースURL

すべてのエンドポイントは、このベースURLを基準としています。

https://www.stickermule.com/api

エンドポイント

GET /api/items - アイテムを一覧にする

再注文可能なアイテムを返します。各アイテムのIDは、注文作成時にitems[].idとして有効です。

GET /api/items

コピー

curl "https://www.stickermule.com/api/items?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

クエリパラメータ

パラメータ	種類	デフォルト	説明
limit	number	20	返すアイテムの数（1～50）。
offset	number	0	結果を返す前にスキップするアイテムの数。
currency	string	USD	価格にはISO 4217通貨コードを使用。
locale	string	en	製品名と価格に使用される地域設定。

応答

結果は、limitとoffsetに基づいてページ分割され、canLoadMoreは、利用可能なアイテムがさらにある場合にtrueになります。ページ分割はoffsetに基づいて行われるため、新しい注文が入るとページが移動することがあります。

フィールド	種類	説明
id	string	アイテム識別子。注文を作成する際は、items[].id として使用すること。
name	string | null	アイテムに付けた、カスタマイズされた名称（もしあれば）。
productId	number	ステッカーミュール 製品識別子。
productName	string | null	製品名。製品が入手できない場合はnull。
quantity	number	元の注文の数量。
size	RegularItemDimensions | TShirtDimensions | HoodieDimensions	商品のサイズ。Tシャツおよびヘビーウェイト Tシャツの場合は、__typename TShirtDimensionsを持つアパレルサイズオブジェクトとサイズ。パーカーの場合は、__typename HoodieDimensions とサイズ。その他のすべての製品については、__typename RegularItemDimensionsを持つインチ単位の実寸と幅および高さ。
isSizeRequired	boolean	製品（Tシャツ、ヘビーウェイト Tシャツ、パーカー）の再注文にサイズが必要な場合はtrue。それ以外はfalse。
buyingOptions	object | null	再注文数量は、最小値、最大値、増分値として指定できます。商品が入手できない場合はnullとします。
retailPrice	number | null	最低数量での価格、または価格情報が入手できない場合はnull。
artworkUrls	string[]	当該アイテムに承認されたアートワークのURL。

応答例

コピー

{
  "items": [
    {
      "id": "456",
      "name": "Logo stickers",
      "productId": 12,
      "productName": "Die cut stickers",
      "quantity": 50,
      "size": { "__typename": "RegularItemDimensions", "width": 3, "height": 3 },
      "isSizeRequired": false,
      "buyingOptions": {
        "quantity": { "min": 50, "max": 5000, "increment": 5 }
      },
      "retailPrice": 79,
      "artworkUrls": ["https://cdn.stickermule.com/artwork.png"]
    },
    {
      "id": "789",
      "name": "Team t-shirt",
      "productId": 34,
      "productName": "Custom t-shirts",
      "quantity": 25,
      "size": { "__typename": "TShirtDimensions", "size": "sizeL" },
      "isSizeRequired": true,
      "buyingOptions": {
        "quantity": { "min": 1, "max": 500, "increment": 1 }
      },
      "retailPrice": 18,
      "artworkUrls": ["https://cdn.stickermule.com/shirt.png"]
    },
    {
      "id": "812",
      "name": "Team hoodie",
      "productId": 56,
      "productName": "Custom hoodies",
      "quantity": 10,
      "size": { "__typename": "HoodieDimensions", "size": "sizeM" },
      "isSizeRequired": true,
      "buyingOptions": {
        "quantity": { "min": 1, "max": 500, "increment": 1 }
      },
      "retailPrice": 32,
      "artworkUrls": ["https://cdn.stickermule.com/hoodie.png"]
    }
  ],
  "canLoadMore": true
}

GET /api/addresses - 住所を一覧にする

保存済みの配送先住所を返します（デフォルトが優先されます）。各IDは、注文作成時のaddressIdとして有効です。

GET /api/addresses

コピー

curl https://www.stickermule.com/api/addresses \
  -H "Authorization: Bearer YOUR_API_KEY"

応答

フィールド	種類	説明
id	string	住所識別子。注文作成時にaddressIdとして使用してください。
name	string | null	受取人の氏名（フルネーム）。
firstName	string | null	受取人の名前（ファーストネーム）。
lastName	string | null	受取人の姓。
companyName	string | null	会社名（該当する場合）。
addressLine1	string	番地と街路名。
addressLine2	string | null	追加の住所欄（該当する場合）。
cityName	string	市。
stateName	string | null	該当する場合、州または県の名称。
stateAbbreviation	string | null	州または県の略称（該当する場合）。
zipCode	string	郵便番号。
countryIso	string	ISO 3166国コード（例えば、US）。
countryName	string	国名。
phone	string | null	連絡先電話番号（もしあれば）。
isDefault	boolean	デフォルトの配送先住所については、この通りです。

応答例

コピー

{
  "addresses": [
    {
      "id": "22",
      "name": "Jane Doe",
      "firstName": "Jane",
      "lastName": "Doe",
      "companyName": null,
      "addressLine1": "123 Main St",
      "addressLine2": null,
      "cityName": "Amsterdam",
      "stateName": null,
      "stateAbbreviation": null,
      "zipCode": "1000AA",
      "countryIso": "NL",
      "countryName": "Netherlands",
      "phone": "+31612345678",
      "isDefault": true
    }
  ]
}

GET /api/payments - 支払い方法を一覧にする

保存済みの支払い方法を返します。デフォルトを優先します。各IDは、注文作成時のpaymentIdとして有効です。

GET /api/payments

コピー

curl https://www.stickermule.com/api/payments \
  -H "Authorization: Bearer YOUR_API_KEY"

応答

フィールド	種類	説明
id	string	支払い方法識別子。注文作成時にpaymentIdとして使用してください。
ccType	string	VisaやMastercardなどのカードブランド。
lastDigits	string	カード番号の下4桁。
expiration	object	カードの有効期限（月と年）。
isDefault	boolean	デフォルトの支払い方法については、trueです。

応答例

コピー

{
  "payments": [
    {
      "id": "7",
      "ccType": "visa",
      "lastDigits": "1007",
      "expiration": { "month": 7, "year": 2028 },
      "isDefault": true
    }
  ]
}

GET /api/orders - 注文一覧

ご注文を最新のものから順に一覧表示します。各注文の番号は、POST /api/ordersで返される番号と一致します。

GET /api/orders

コピー

curl "https://www.stickermule.com/api/orders?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

クエリパラメータ

パラメータ	種類	デフォルト	説明
limit	number	10	返す注文数（1～50）。
offset	number	0	結果を返す前に抜かす注文数。

応答

検索結果はlimitとoffsetに基づいてページ分割され、canLoadMoreは注文がさらにある場合にtrueになります。ページングはoffsetに基づいて行われるため、新しい注文が入るとページがずれることがあります。

フィールド	種類	説明
number	string	注文番号。POST /api/orders で返される値と同じです。
state	"complete" | "canceled" | "gift_unclaimed" | "ready_for_production" | "in_production" | "ready_to_proof" | "awaiting_scheduled_date"	注文状況。
paymentState	"paid" | "credit_owed" | "balance_due" | "failed" | "checkout" | "completed" | "pending" | "processing" | "void" | null	注文の支払い状況、またはnull。
shipmentState	"backorder" | "canceled" | "partial" | "pending" | "ready" | "shipped" | "returned_for_reship" | "reship" | "delivered"	注文の出荷状況。デフォルトは「保留中」です。
placedAt	string	注文が行われた時点、ISO 8601タイムスタンプとして。
currency	string	注文で請求に使われたISO 4217通貨。
itemTotal	number	送料、税金、割引適用前のアイテム小計。
total	number	送料と税金を含めた合計金額から割引額を差し引いた請求額です。
expectedDeliveryDate	string | null	ISO 8601タイムスタンプとしての推定配送日、またはnull。
deliveredAt	string | null	注文が配達された時点、ISO 8601タイムスタンプとして、またはnull。

応答例

コピー

{
  "orders": [
    {
      "number": "R286234605",
      "state": "complete",
      "paymentState": "paid",
      "shipmentState": "shipped",
      "placedAt": "2026-07-20T14:03:00.000Z",
      "currency": "USD",
      "itemTotal": 79,
      "total": 88.5,
      "expectedDeliveryDate": "2026-07-27T00:00:00.000Z",
      "deliveredAt": null
    }
  ],
  "canLoadMore": true
}

POST /api/orders - 注文を作成する

保存済みアイテムを1点以上注文し、保存済み住所に配送してもらい、保存済みの支払い方法で請求します。

POST /api/orders

コピー

curl -X POST https://www.stickermule.com/api/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "id": "456", "quantity": 50 }],
    "addressId": "22",
    "paymentId": "7"
  }'

リクエスト本文

フィールド	種類	必須	説明
items	array	はい	注文するアイテム。最低1点以上含める必要があります。
items[].id	string	はい	GET /api/items からのアイテムID。
items[].quantity	number	はい	当該アイテムの注文数量。
items[].size	TShirtSize | HoodieSize | null	いいえ	アパレルのサイズは、アパレル（Tシャツ、ヘビーウェイト Tシャツ、パーカー）をご注文の際に必須です。製品に合った下記のサイズをお選びください。その他の製品については入力不要です。
addressId	string	はい	GET /api/addresses からの住所ID。
paymentId	string	はい	GET /api/payments から取得した支払い方法 ID。

1回の注文には最大50個のアイテムを含めることができます。各数量は、GET /api/itemsからの製品の最小、最大、および増分値を遵守する必要があります。

アパレルのサイズ

有効なサイズは、製品のカットによって異なります：

• Ｔシャツおよびヘビーウェイト Tシャツ（TShirtSize）： "sizeYS" | "sizeYM" | "sizeYL" | "sizeS" | "sizeM" | "sizeL" | "sizeXL" | "size2XL" | "size3XL" | "size4XL" | "size5XL" | "size6XL" | "size7XL"
• パーカー（HoodieSize）： "sizeS" | "sizeM" | "sizeL" | "sizeXL" | "size2XL"

応答

応答例

コピー

{
  "order": { "number": "R286234605" }
}

エラー

エラーの場合は、該当するHTTPステータスと、タイプおよびメッセージを含むJSONボディが返されます。

{
  "type": "UserInputError",
  "message": "items is required and must be a non-empty array"
}

どのように組み合わさるか

• 注文できるのは、過去に注文したアイテムのみです。オリジナルアイテム、梱包用テープ、ビニールレタリングはAPI経由では注文できません。
• まず、アイテム、住所、支払い方法を読み込み、それらのIDをPOST /api/ordersにパスします。
• GET /api/ordersは、注文を最新のものから順に表示します。各注文の番号は、POST /api/ordersが返す番号と一致します。
• ほとんどの製品は、元の寸法（幅と高さ、単位はインチ）で再注文されます。アパレル（Tシャツ、ヘビーウェイト Tシャツ、パーカー）は、代わりにアパレルサイズが設定されます。GET /api/itemsを実行すると、isSizeRequiredがtrueのサイズが返され、items[].sizeをパスして注文します。有効なサイズは製品によって異なり、再注文時にサイズを変更できます。たとえば、サイズMのシャツをサイズLとして再注文できます。
• GET /api/itemsとGET /api/ordersはlimitとoffsetによりページ分割されますが、住所と支払いのエンドポイントはこのようなページ分割は行われません。