products
This page is the command reference for @orchestor-inc/cli.
Commands
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
Creates 1–1,000 approved catalog products and returns every item in the created or rejected bucket. A partial rejection does not hide the successful items or rejection reasons from JSON output.
Usage
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 --jsonFlags
| Flag | Type | Required | Description |
|---|---|---|---|
--products | string | Yes | JSON array of product objects. Use --stdin for a complete request body. |
--idempotency-key | string | No | Stable key that returns the same result on retry. |
See global flags for output and request options.
orc products list
List products
Usage
orc products list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--brand-id | string | No | value |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product list
Help
orc products list --helporc products get
Gets a product by ID from the selected workspace. A product ID belonging to another workspace is rejected as not found.
Usage
orc products get YOUR_PRODUCT_ID --workspace YOUR_WORKSPACE_ID --jsonArguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Product ID |
See global flags for output and request options.
orc products update
Updates 1–1,000 products. Inspect the updated, skipped, and rejected buckets separately.
Usage
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 --jsonFlags
| Flag | Type | Required | Description |
|---|---|---|---|
--products | string | Yes | JSON array of product objects with IDs and changed fields. Use --stdin for a complete request body. |
--idempotency-key | string | No | Stable key that returns the same result on retry. |
See global flags for output and request options.
orc products delete
Soft-deletes 1–1,000 products and returns deleted and skipped. Interactive terminals prompt for confirmation; noninteractive runs require --yes before the CLI sends a request.
Usage
printf '%s' '{"ids":["YOUR_PRODUCT_ID"]}' \
| orc products delete --workspace YOUR_WORKSPACE_ID --stdin --idempotency-key YOUR_REQUEST_KEY --yes --jsonFlags
| Flag | Type | Required | Description |
|---|---|---|---|
--ids | string | Yes | Comma-separated product IDs. Use --stdin for a JSON request body. |
--idempotency-key | string | No | Stable key that returns the same result on retry. |
--yes | boolean | No | Skip the deletion prompt in noninteractive use. |
--dry-run prints the request body and selected workspace without calling the API.
orc products attribute-keys list
Lists the custom attribute keys used by products in the selected workspace.
Usage
orc products attribute-keys list --workspace YOUR_WORKSPACE_ID --jsonSee global flags for output and request options.
orc products summary get
Get product summary
Usage
orc products summary get [flags]See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product summary
Help
orc products summary get --helporc products competitors list
List product competitors
Usage
orc products competitors list <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Path parameter: id |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product competitors
Help
orc products competitors list --helporc products fanouts list
List product fanouts
Usage
orc products fanouts list <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Path parameter: id |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product fanouts
Help
orc products fanouts list --helporc products attributes list
List product attributes
Usage
orc products attributes list <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Path parameter: id |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product attributes
Help
orc products attributes list --helporc products prompts list
List product prompts
Usage
orc products prompts list <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Path parameter: id |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc product prompts
Help
orc products prompts list --help