Skip to main content

Product groups

The grouping of the product catalogue, with its own ordering and archiving.

CommandHTTPDescription
product-groups listGET /v1/product_groupsList product groups
product-groups createPOST /v1/product_groupsCreate a product group
product-groups getGET /v1/product_groups/{id}Get a product group
product-groups updatePATCH /v1/product_groups/{id}Update a product group
product-groups deleteDELETE /v1/product_groups/{id}Remove a product group
product-groups archive createPOST /v1/product_groups/{id}/archiveArchive a product group
product-groups archive deleteDELETE /v1/product_groups/{id}/archiveUnarchive a product group
product-groups reorder createPOST /v1/product_groups/reorderReorder product groups
product-groups reorder updatePUT /v1/product_groups/reorderReorder 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​