products
@orchestor-inc/cli のコマンドリファレンスです。
コマンド一覧
orc products create— Create productsorc products list— List productsorc products get— Get productorc products update— Update productsorc products delete— Delete productsorc products attribute-keys list— List product attribute keysorc products summary get— Get product summaryorc products competitors list— List product competitorsorc products fanouts list— List product fanoutsorc products attributes list— List product attributesorc products prompts list— List product prompts
orc products create
承認済みの商品を 1〜1,000 件登録し、created と rejected の各項目を返します。一部の項目が拒否されても、成功した項目と拒否理由を同じ JSON 出力で確認できます。
構文
printf '%s' '{"products":[{"external_id":"YOUR_EXTERNAL_ID","brand_id":"YOUR_BRAND_ID","name":"YOUR_PRODUCT_NAME","attributes":{"category":"YOUR_CATEGORY"}}]}' \
| orc products create --workspace YOUR_WORKSPACE_ID --stdin --idempotency-key YOUR_REQUEST_KEY --jsonフラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--products | string | はい | 商品オブジェクトの JSON 配列。完全な本文には --stdin を使用します。 |
--idempotency-key | string | いいえ | 再試行時に同じ結果を返すための一意なキー。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。
orc products list
List products
構文
orc products list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--brand-id | string | いいえ | value |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product list
ヘルプ
orc products list --helporc products get
選択したワークスペースの商品を ID で取得します。別のワークスペースの商品 ID は not found として拒否されます。
構文
orc products get YOUR_PRODUCT_ID --workspace YOUR_WORKSPACE_ID --json引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | 商品 ID |
出力とリクエストの共通オプションはグローバルオプションを参照してください。
orc products update
1〜1,000 件の商品を一括更新します。出力の updated、skipped、rejected を個別に確認してください。
構文
printf '%s' '{"products":[{"id":"YOUR_PRODUCT_ID","name":"YOUR_UPDATED_PRODUCT_NAME"}]}' \
| orc products update --workspace YOUR_WORKSPACE_ID --stdin --idempotency-key YOUR_REQUEST_KEY --jsonフラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--products | string | はい | ID と変更項目を持つ商品オブジェクトの JSON 配列。完全な本文には --stdin を使用します。 |
--idempotency-key | string | いいえ | 再試行時に同じ結果を返すための一意なキー。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。
orc products delete
1〜1,000 件の商品を論理削除し、deleted と skipped を返します。対話端末では確認を求め、非対話実行では API を呼ぶ前に --yes を要求します。
構文
printf '%s' '{"ids":["YOUR_PRODUCT_ID"]}' \
| orc products delete --workspace YOUR_WORKSPACE_ID --stdin --idempotency-key YOUR_REQUEST_KEY --yes --jsonフラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--ids | string | はい | カンマ区切りの商品 ID。JSON 本文には --stdin を使用します。 |
--idempotency-key | string | いいえ | 再試行時に同じ結果を返すための一意なキー。 |
--yes | boolean | いいえ | 非対話実行で削除確認を省略。 |
--dry-run はリクエスト本文と対象ワークスペースを表示しますが、API を呼びません。
orc products attribute-keys list
選択したワークスペースの商品で使われているカスタム属性キーを一覧します。
構文
orc products attribute-keys list --workspace YOUR_WORKSPACE_ID --json出力とリクエストの共通オプションはグローバルオプションを参照してください。
orc products summary get
Get product summary
構文
orc products summary get [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product summary
ヘルプ
orc products summary get --helporc products competitors list
List product competitors
構文
orc products competitors list <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product competitors
ヘルプ
orc products competitors list --helporc products fanouts list
List product fanouts
構文
orc products fanouts list <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product fanouts
ヘルプ
orc products fanouts list --helporc products attributes list
List product attributes
構文
orc products attributes list <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product attributes
ヘルプ
orc products attributes list --helporc products prompts list
List product prompts
構文
orc products prompts list <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc product prompts
ヘルプ
orc products prompts list --help