テスト環境から本番環境に商品を公開します。これは一方向の初回公開のみの操作で、現在のテストバージョンを本番環境にコピーします。
POST /v1/actions/onetime-product/publish-product
認証: API Key
このエンドポイントには X-Environment ヘッダーを含めないでください。公開は常にテストから本番環境への一方向です。
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
id | string | Yes | 商品 ID(Short ID フォーマット PROD_xxx) |
リクエスト例
const { product } = await client.onetimeProducts.publish({
id: "PROD_3kF9mNpQrStUvWxYz1A2bC",
});
成功レスポンス (200)
{
"data": {
"product": {
"id": "PROD_3kF9mNpQrStUvWxYz1A2bC",
"storeId": "STO_2aUyqjCzEIiEcYMKj7TZtw",
"name": "Premium Template Pack",
"description": "50 premium design templates for your next project.",
"prices": {
"USD": { "amount": "49.00", "taxCategory": "digital_goods" },
"EUR": { "amount": "45.00", "taxCategory": "digital_goods" }
},
"media": [
{ "type": "image", "url": "https://example.com/templates-preview.png", "alt": "Template preview" }
],
"successUrl": "https://example.com/thank-you",
"metadata": { "category": "design", "fileCount": "50" },
"status": "active",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z"
}
}
}
レスポンスフィールド
商品の作成レスポンスと同じです。
初回公開のみサポートされています。商品に本番バージョンが存在する場合、このエンドポイントは同じ商品に再度使用できません。初回公開後に本番バージョンを更新するには、X-Environment: prod ヘッダーを付けて商品の更新エンドポイントを使用してください。
エラー
リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
| ステータス | errors[0].message | 意味 | 推奨処理 |
|---|
| 400 | Missing required field: id | id が指定されていません | ボディを修正して再送信 |
| 400 | Invalid ID format | 指定された Short ID をデコードできませんでした | id のフォーマットを修正して再送信 |
| 400 | No test version found | 商品にテスト環境のバージョンがまだ存在しない | まず Create Product で商品を作成 |
| 400 | Test version is not active | 現在のテストバージョンのステータスが inactive | 先に Update Status でテストバージョンを有効化 |
| 400 | Already published to production | 商品は既に本番バージョンを持っている | 以降の変更は Update Product に X-Environment: prod を付けて実施 |
| 404 | Product not found | 商品が存在しないかアクセスできません | id が現在のマーチャントに属することを確認 |
| 500 | Internal server error | サーバ側の予期しない障害 | 指数バックオフでリトライ(5s 開始、最大 3 回) |