--- title: products description: 商品カタログの登録・一括編集と観測情報の参照を行う。 canonical_url: https://orchestor.io/docs/cli/product markdown_url: https://orchestor.io/docs/cli/product.md contentType: reference --- # products `orc products` は、Workspaceの商品カタログを管理するコマンドです。承認済み商品の一括登録・更新・削除、一覧・詳細・集計の取得に加え、観測で見つかった競合商品、検索展開、属性、元のプロンプトを確認できます。JANや公開商品URLから、登録前に根拠付きの商品候補を調べる操作もあります。認証を設定して対象Workspaceを選びます。`get` と商品別の観測情報には、作成・一覧で返されたOrchestor商品IDを使用してください。`external_id` や観測されたshopping結果IDは、このIDの代わりにはなりません。別のWorkspaceの商品IDは取得できません。 ## 使い方 ```bash title="terminal" orc products list --workspace ``` *商品カタログと商品IDを確認します。* ## サブコマンド ### `list` 有効な商品を新しい順に一覧します。`--brand-id` で絞り込み、同じ条件でnext cursorをたどります。 ```bash title="terminal" orc products list [options] ``` #### 固有のオプション ##### `--brand-id` Filter by a brand ID in the current workspace. Omit to list products across all its brands. 型: `string`。任意。 ```bash title="terminal" orc products list --brand-id ``` ### `create` 1〜1,000件を登録します。`products` 配列の各商品に現在のWorkspaceのブランドが必要です。結果は `created` と `rejected` に分かれ、一部拒否の場合も各項目を確認できます。本文全体のschema検証に失敗すると処理前に拒否されます。 ```bash title="terminal" orc products create [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc products create --idempotency-key ``` ##### `--products` (required) Catalog products to create in request order. Each item creates a new product.; JSON array of objects (use --stdin for large resources) 型: `string`。任意。 ```bash title="terminal" orc products create --products ``` #### 使用例同じ本文の再試行では同じrequest keyを保持し、結果の各bucketを確認します。 ```bash title="terminal" orc products create --workspace --stdin --idempotency-key --json < products.json ``` *承認済みの商品を一括登録する* ### `update` Orchestor商品IDと変更項目を含む `products` 配列で1〜1,000件を更新します。指定項目だけを変更し、結果を `updated`、`skipped`、`rejected` で返します。不明IDは `not_found`、変更項目なしは `no_changes` でskipします。 ```bash title="terminal" orc products update [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc products update --idempotency-key ``` ##### `--products` (required) Partial updates in request order. Each item requires an Orchestor product ID.; JSON array of objects (use --stdin for large resources) 型: `string`。任意。 ```bash title="terminal" orc products update --products ``` #### 使用例 ```bash title="terminal" orc products update --workspace --stdin --idempotency-key --json < products-update.json ``` *商品名を一括更新する* ### `delete` `ids` 配列または `--ids` のCSVで1〜1,000件を論理削除します。`deleted` と `skipped` を確認してください。不明または削除済みIDは `not_found` でskipします。非対話時は `--yes` が必要です。 ```bash title="terminal" orc products delete [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc products delete --idempotency-key ``` ##### `--ids` (required) Orchestor product IDs to delete, processed in request order. Repeating an ID can result in a skipped entry after its first deletion.; csv 型: `string`。任意。 ```bash title="terminal" orc products delete --ids ``` #### 使用例 ```bash title="terminal" orc products delete --workspace --stdin --idempotency-key --yes --json < products-delete.json ``` *確認済みの商品を非対話で削除する* ### `summary get` 有効な商品件数と、その商品の異なるブランド数を取得します。空のカタログは両方0です。 ```bash title="terminal" orc products summary get [options] ``` ### `attribute-keys list` 有効な商品の `attributes` で使われる、異なる最上位キーを一覧します。入れ子のキーは展開しません。 ```bash title="terminal" orc products attribute-keys list [options] ``` ### `get` 商品IDで選択Workspace内の1件を取得します。別Workspaceの商品は `not found` になります。 ```bash title="terminal" orc products get [options] ``` ### `competitors list` 同じ観測sliceに現れた競合shopping結果をvisibility順で確認します。商品自体が現れた元の質問には `prompts list` を使用します。 ```bash title="terminal" orc products competitors list [options] ``` ### `fanouts list` 商品に関連する生成shopping queryを観測数順で取得します。元の質問ではなく、商品根拠へつながる検索展開を確認します。 ```bash title="terminal" orc products fanouts list [options] ``` ### `attributes list` 観測された特徴、offerの事実、評価の根拠をsourceと頻度でまとめて取得します。カタログのカスタム属性キー一覧とは異なります。 ```bash title="terminal" orc products attributes list [options] ``` ### `prompts list` 商品に一致するshopping観測を持つプロンプトを、出現数と平均絶対順位を含めて取得します。 ```bash title="terminal" orc products prompts list [options] ``` ### `resolve-jan` `--jan` でJAN/EANの商品候補とURL根拠を調べます。任意の `--official-domain` は利用者の申告で、所有者検証ではありません。`--search false` と公開URL入力も使用できます。登録は行いません。APIキーにはPOSTの書き込みscopeが必要です。 ```bash title="terminal" orc products resolve-jan [options] ``` #### 固有のオプション ##### `--jan` (required) Body field: jan 型: `string`。任意。 ```bash title="terminal" orc products resolve-jan --jan ``` ##### `--official-domain` Caller-supplied manufacturer domain hint. Not independently verified ownership.; max 253 chars 型: `string`。任意。 ```bash title="terminal" orc products resolve-jan --official-domain ``` ##### `--search` Allows at most two paid organic search requests using the configured DataForSEO provider. 型: `string`。任意。 ```bash title="terminal" orc products resolve-jan --search ``` ##### `--urls` Optional public product pages to inspect, also usable without a search provider.; csv 型: `string`。任意。 ```bash title="terminal" orc products resolve-jan --urls ``` ### `extract` `--urls` またはJSONで1〜5件の公開商品URLを指定し、Product/ProductGroup JSON-LDと対応するstorefront HTMLから出典付きの事実を抽出します。検索やカタログ登録は行いません。APIキーには書き込みscopeが必要です。 ```bash title="terminal" orc products extract [options] ``` #### 固有のオプション ##### `--urls` (required) Body field: urls; csv 型: `string`。任意。 ```bash title="terminal" orc products extract --urls ``` ## 使用例 ### 商品登録の入力 ```json title="products.json" { "products": [ { "external_id": "YOUR_EXTERNAL_ID", "brand_id": "YOUR_BRAND_ID", "name": "YOUR_PRODUCT_NAME", "attributes": { "category": "YOUR_CATEGORY" } } ] } ``` *商品登録の入力* ### 商品更新の入力 ```json title="products-update.json" { "products": [ { "id": "YOUR_PRODUCT_ID", "name": "YOUR_UPDATED_PRODUCT_NAME" } ] } ``` *商品更新の入力* ### 商品削除の入力 ```json title="products-delete.json" { "ids": [ "YOUR_PRODUCT_ID" ] } ``` *商品削除の入力* ### 削除リクエストを確認する本文と対象Workspaceを表示し、APIへ送りません。 ```bash title="terminal" orc products delete --workspace --stdin --dry-run < products-delete.json ``` *削除リクエストを確認する* ## 根拠の調査と登録 JANの解決は最大2回の有料DataForSEO検索と10件の公開ページに制限され、robotsとネットワーク制約に従います。checksum検証はGS1登録確認ではなく、GS1 registryも接続していません。正確なGTIN一致と未検証の検索候補を区別し、現在販売中かは確認しません。URL抽出は検索・registry照会・browser bypassを行いません。これらの結果を確認・承認してから `products create` へ渡してください。一括処理ではコマンド全体の成功だけでなく各bucketの結果を確認します。削除された商品は一覧・集計・属性キー探索から外れます。 ## 必要な権限対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。 ## グローバルオプション `orc products` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。 - [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5) - [`--limit`](https://orchestor.io/docs/cli/global-flags.md) - [`--cursor`](https://orchestor.io/docs/cli/global-flags.md) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93) - [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89) - [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91) 各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。 --- [Documentation index](https://orchestor.io/docs/llms.txt)