Product groups
The grouping of the product catalogue, with its own ordering and archiving.
| Command | HTTP | Description |
|---|---|---|
product-groups list | GET /v1/product_groups | List product groups |
product-groups create | POST /v1/product_groups | Create a product group |
product-groups get | GET /v1/product_groups/{id} | Get a product group |
product-groups update | PATCH /v1/product_groups/{id} | Update a product group |
product-groups delete | DELETE /v1/product_groups/{id} | Remove a product group |
product-groups archive create | POST /v1/product_groups/{id}/archive | Archive a product group |
product-groups archive delete | DELETE /v1/product_groups/{id}/archive | Unarchive a product group |
product-groups reorder create | POST /v1/product_groups/reorder | Reorder product groups |
product-groups reorder update | PUT /v1/product_groups/reorder | Reorder product groups (PUT alias) |
Examples
--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.
# List product groups
kobana billing product-groups list \
--fields "id,public_id,external_id,organization_id,company_id"
# Get a product group
kobana billing product-groups get --params '{"id": "PRODUCT_GROUP_ID"}'
# Create a product group
kobana billing product-groups create --json '{"name": "NAME"}'
# Update a product group
kobana billing product-groups update \
--params '{"id": "PRODUCT_GROUP_ID"}' \
--json '{"name": "NAME", "slug": "SLUG", "company_id": "COMPANY_ID"}'
# Remove a product group
kobana billing product-groups delete \
--params '{"id": "PRODUCT_GROUP_ID"}' \
--dry-run
Next steps
- Service items
- Schema introspection — every parameter this resource accepts.