Products

Generated from the CLI command contract. Do not edit this page manually.

`nimbu products`

Manage products

`nimbu products attachments`

Manage product attachments

`nimbu products attachments create`

Create a product attachment

Arguments

Name	Required	Description
`assignments`	no	Inline attachment field assignments

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug
`--file`	no		Read JSON from file (use - for stdin)

`nimbu products attachments delete`

Delete a product attachment (requires --force)

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug
`--attachment`	yes		Attachment ID

`nimbu products attachments download`

Download a product attachment

Flags

Flag	Required	Description
`--product`	yes	Product ID or slug
`--attachment`	yes	Attachment ID
`--output`	yes	Write the file to this path, or - for stdout

`nimbu products attachments get`

Get a product attachment

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug
`--attachment`	yes		Attachment ID

`nimbu products attachments list`

List product attachments

Flags

Flag	Required	Description
`--fields`	no	Comma-separated fields to return
`--locale`	no	Filter by locale
`--include`	no	Include related resources
`--sort`	no	Sort by field, e.g. field or field:desc
`--filters`	no	Filter by key=value, repeatable
`--product`	yes	Product ID or slug

`nimbu products attachments update`

Update a product attachment

Arguments

Name	Required	Description
`assignments`	no	Inline attachment field assignments

Flags

Flag	Required	Description
`--product`	yes	Product ID or slug
`--attachment`	yes	Attachment ID
`--file`	no	Read JSON from file (use - for stdin)

`nimbu products config`

Copy or diff product customizations

`nimbu products config copy`

Copy product customizations between sites

Flags

Flag	Required	Description
`--from`	yes	Source site
`--to`	yes	Target site
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu products config diff`

Diff product customizations between sites

Flags

Flag	Required	Description
`--from`	yes	Source site
`--to`	yes	Target site
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu products copy`

Copy products between sites

Flags

Flag	Required	Description
`--from`	yes	Source site
`--to`	yes	Target site
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host
`--allow-errors`	no	Continue on item-level validation errors

`nimbu products count`

Count products

Flags

Flag	Required	Default	Description
`--locale`	no		Filter by locale
`--filters`	no		Filter by key=value, repeatable

`nimbu products create`

Create a product

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. name=Wine, price:=19.9)

Flags

Flag	Required	Default	Description
`--file`	no		Read product JSON from file (use - for stdin)

`nimbu products delete`

Delete a product

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug

`nimbu products fields`

Show product field schema

`nimbu products get`

Get product by ID or slug

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug

`nimbu products list`

List products

Flags

Flag	Required	Default	Description
`--fields`	no		Comma-separated fields to return
`--locale`	no		Filter by locale
`--include`	no		Include related resources
`--sort`	no		Sort by field, e.g. field or field:desc
`--filters`	no		Filter by key=value, repeatable
`--all`	no		Fetch all pages
`--page`	no	`1`	Page number
`--per-page`	no	`25`	Items per page

`nimbu products update`

Update a product

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. name=Wine, price:=19.9)

Flags

Flag	Required	Default	Description
`--product`	yes		Product ID or slug
`--file`	no		Read product JSON from file (use - for stdin)

On this page