POST /v1/catalogue/sets

Add an empty product set to the catalogue.

Adds a product set, empty. Put products in it with their sets — on POST or PATCH /v1/catalogue/products/{product_id}, or the sets column of an import.

Needs the catalogue.products:write scope.

Body

Field	Type	Required	Notes
name	string	Yes	Up to 80 characters, not used by another of the account’s sets.
description	string	No	Up to 200 characters.

Request

cURL

curl -X POST "https://api.fireflo.au/v1/catalogue/sets" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Diwali edit",
  "description": "Festive picks, sent as one product list."
}'

Response

201 Created — the set.

{
  "id": "c4e81f2a-6b7d-4a39-8e15-0d3f9b2a7c61",
  "name": "Diwali edit",
  "description": "Festive picks, sent as one product list.",
  "products": 0
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
400	invalid_request	name is missing, empty, too long or already a set’s, or description is too long (field names it).
404	module_off	The account doesn’t have Catalogue on.
403	scope_missing	The key doesn’t have the catalogue.products:write scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.