Reporting Groups

Each product can be assigned to at most one reporting group.

Get all reporting groups

GET /v1/companies/1234/reporting_groups Get all reporting groups

Get a reporting group

GET /v1/companies/1234/reporting_groups/2345 Get a reporting group

Create a reporting group

POST /v1/companies/1234/reporting_groups Create a new reporting group

Update a reporting group

PUT /v1/companies/1234/reporting_groups/2345 Update a reporting group

Delete a reporting group

DELETE /v1/companies/1234/reporting_groups/2345 Delete a reporting group
  • The link between the assigned products and the deleted reporting group will be removed automatically upon success.

Add products to a reporting group

PUT /v1/companies/1234/reporting_groups/2345/products Add products to a reporting group
  • A variant product cannot be assigned to a reporting group.
  • In the above example, upon success, the two products will have been assigned to the new reporting group. The links to their original reporting groups will have been removed. Other products that have already been assigned to the new reporting group are not affected.

Remove a product from a reporting group

DELETE /v1/companies/1234/reporting_groups/2345/products/1 Remove a product from a reporting group
  • A variant product cannot be removed from a reporting group.
  • Only one product is removed from a reporting group. Other products that have been assigned to the reporting group are not affected.