STORES APIドキュメント (202109)

Download OpenAPI specification:Download

STORES APIの利用方法を記載したドキュメントです。

注意事項

User-Agent の指定がない場合にエラーレスポンスを返すことがあります。

Authentication

Bearer Authentication

APIアクセスを行う際にはAuthorizationヘッダにcredentialを指定してください。

$ curl -H 'Authorization: bearer {credential}' https://api.stores.dev/retail/202109/orders

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

オーダー一覧(ネットショップのみ)

オーダーの一覧をオーダーされた日時の降順で返します。

※実際のオーダー日時からこのAPIに出力されるまでに時間がかかる場合があります。

query Parameters

ids	string オーダー番号で検索する場合に指定してください。複数指定する場合はカンマ(,)区切りで指定してください。オーダー番号は数字のみ指定可能です。
status	string Enum: "shipped" "repayment" "pending" "unpaid" "cancel" オーダーステータスで検索する場合に指定してください。 shipped ... 完了 repayment ... 返金済み pending ... 未発送 unpaid ... 入金待ち cancel ... キャンセル
ordered_at_from	string <date-time> 特定の日時以降のオーダーを検索したい場合に指定してください。フォーマット: `YYYY-MM-DD` または `YYYY-MM-DDThh:mm:ss`
ordered_at_to	string <date-time> 特定の日時以前のオーダーを検索したい場合に指定してください。フォーマット: `YYYY-MM-DD` または `YYYY-MM-DDThh:mm:ss`
direction	string Default: "desc" Enum: "desc" "asc" オーダー日時による並べ替えの方向を指定します。 desc ... 降順 asc ... 昇順
limit	integer [ 1 .. 100 ] Default: 10 取得するデータの最大件数
offset	integer >= 0 Default: 0 取得をスキップする件数

Responses

Response samples

Content type

application/json

{"orders": [{"id": "2542291983",
"status": "pending",
"payment_method_name": "credit",
"payment_method_fee": 0,
"ordered_at": "2021-09-03T11:59:38+09:00",
"receipt_at": "2021-09-03T11:59:38+09:00",
"shipped_at": null,
"shipping_fee": 200,
"coupon": {"name": "期間限定値引きクーポン",
"discount_amount": 100
},
"sales_amount": 1090,
"tax_amount": 99,
"total_tax_amounts": [{"tax_rate": 0.1,
"sales_amount": 1090,
"tax_amount": 99
}
],
"payment_fee": 40,
"payment_fee_rate": 3.6,
"billing_address": {"last_name": "田中",
"first_name": "太郎",
"zip_code": "1500011",
"prefecture": "東京都",
"address": "渋谷区東3丁目16番3号",
"tel": "00000000000"
},
"shipping_address": {"last_name": "田中",
"first_name": "太郎",
"zip_code": "1500011",
"prefecture": "東京都",
"address": "渋谷区東3丁目16番3号",
"tel": "00000000000"
},
"email": "example@example.com",
"memo": "",
"option": {"receipt_address": "〇〇株式会社",
"note": "備考欄",
"wrapping_fee": 0,
"wrapping_name": "ラッピングなし"
},
"items": [{"name": "オリジナルTシャツ",
"variation_name": "M",
"code": "AB1234-C5",
"barcode": "4912345123459",
"quantity": 1,
"price": 990,
"regular_price": 1100,
"type": "regular",
"preorder_sales": null,
"discount_amount": 110,
"discount_rate": 0.1,
"volume_discount_amount": 0,
"bundle_sale_discount_amount": 0
}
]
}
]
}

アイテム一覧

アイテムの一覧をダッシュボードで設定されている並び順で返します。

※店舗の在庫数は取得できません。

query Parameters

ids	string アイテムidで検索する場合に指定してください。複数指定する場合はカンマ(,)区切りで指定してください。
status	string Enum: "shown" "hidden" "unlisted" アイテムのステータスで検索する場合に指定してください。 shown ... 公開 hidden ... 非公開 unlisted ... 限定公開
in_stock	boolean 在庫の有無を検索したい場合に指定してください。
only_preorder_sales	boolean Default: false 予約販売のアイテムのみ検索したい場合に`true`を指定してください。
keyword	string <= 100 characters 下記の項目を対象に部分一致の検索を行いたい場合に指定してください。アイテム名アイテム説明バーコード品番 `keyword`を指定した場合、`keyword`の関連度順で結果を返します。
limit	integer [ 1 .. 100 ] Default: 10 取得するデータの最大件数
offset	integer >= 0 Default: 0 取得をスキップする件数

Responses

Response samples

Content type

application/json

{"items": [{"id": "616950cd768f7263b4dab1a1",
"name": "Tシャツ",
"created_at": "2021-12-09T12:30:00+09:00",
"status": "shown",
"image_urls": ["https://example.com/images/1",
"https://example.com/images/2",
"https://example.com/images/3"
],
"price": 900,
"limited_quantity": 0,
"description": "オリジナルのTシャツです。",
"regular_price": 1000,
"reduced_tax": false,
"type": "regular",
"discount_amount": 100,
"discount_rate": 0.1,
"preorder_sales": {"start_month": "202112",
"end_month": "202201",
"start_period": "early",
"end_period": "late"
},
"sales_period": {"period_start_at": "2021-12-09T12:30:00+09:00",
"period_end_at": "2022-01-10T12:30:00+09:00"
},
"variations": [{"id": "5fe0533a768f726223c76f70",
"name": "S",
"quantity": null,
"code": "1",
"barcode": null,
"price": 900,
"regular_price": 1000,
"discount_amount": 100,
"discount_rate": 0.1
},
{"id": "5fe0533a768f726223c76f71",
"name": "M",
"quantity": 20,
"code": "2",
"barcode": "4912345678904",
"price": 900,
"regular_price": 1000,
"discount_amount": 100,
"discount_rate": 0.1
},
{"id": "600a3c13768f72b2a6baabea",
"name": "L",
"quantity": 10,
"code": "3",
"barcode": null,
"price": 900,
"regular_price": 1000,
"discount_amount": 100,
"discount_rate": 0.1
}
]
}
]
}

在庫調整(ネットショップのみ)

ネットショップのアイテムの在庫数を更新します。

path Parameters

variation_id

required

string

バリエーション ID

Request Body schema: application/json

update_type required	string Enum: "absolute" "relative" "unlimited" 更新形式 absolute ... quantity の値を絶対値として在庫数を更新する relative ... quanttiy の値を相対値として在庫数を更新する unlimited ... 在庫数を無制限に更新する
quantity	integer or null 在庫数 `update_type` の値に応じて扱いが変化します。 `update_type` が `unlimited` の場合には指定不要です。

Responses

Request samples

Payload

Content type

application/json

Example

{"update_type": "absolute",
"quantity": 10
}

Response samples

Content type

application/json

{"variation_id": "616950cd768f7263b4dab1a1",
"quantity": 10
}