Create a product

curl -X POST "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Book Title",
    "subtitle": "An Amazing Story",
    "isbn13": "9781234567890",
    "publishing_status_id": "status-uuid",
    "format_id": "format-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "page_count": 250,
    "publication_date": "2024-12-01"
  }'

{
  "success": true,
  "data": {
    "id": "newly-created-uuid",
    "title": "New Book Title",
    "publishing_status_id": "status-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "license_name": "Example License",
    "license_badge_colour": "#7C3AED",
    "organization_id": "your-org-id",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

POST

api

products

curl -X POST "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Book Title",
    "subtitle": "An Amazing Story",
    "isbn13": "9781234567890",
    "publishing_status_id": "status-uuid",
    "format_id": "format-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "page_count": 250,
    "publication_date": "2024-12-01"
  }'

{
  "success": true,
  "data": {
    "id": "newly-created-uuid",
    "title": "New Book Title",
    "publishing_status_id": "status-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "license_name": "Example License",
    "license_badge_colour": "#7C3AED",
    "organization_id": "your-org-id",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Creates a product scoped to the authenticated organisation. You can include related records in the same request. Required: title Optional nested arrays on create:

Key	Purpose
`custom_fields`	Custom field values (`field_id`, `field_value`)
`product_prices`	Retail/list prices by currency
`packing_configurations`	Inner/outer/pallet packing rows
`contributors`	Contributor and role links
`product_collections`	Collection membership
`collateral`	Text content, cited content, and awards

product_form_id is accepted on write but stored on the linked format (when format_id is set), not on the product row itself. license_id must belong to the same organisation.

Headers

string

required

Organisation API key.

string

default:"1.0"

API version. Use 1.0.

string

required

Must be application/json.

Body

string

required

Product title.

string

Subtitle.

string

ISBN-13.

string

ISBN-10.

integer

Positive page count.

string

Publication date string (nullable).

string

Format UUID.

string

Parent title UUID (nullable).

string

Publishing status UUID (ONIX List 64). Pass null to clear on update.

string

Product availability UUID (ONIX List 65).

string

Lifecycle status UUID.

string

Organisation license UUID. Must belong to the authenticated organisation. Omit to create without a license.

string

Season UUID.

string

Publisher UUID.

string

Division UUID.

string

Imprint UUID.

string

Series collection UUID. Must be one of the product’s attached collections when set.

string

Product form UUID. Synced to the linked format when format_id is present.

string

One of normal, kit, kit_part, indent, charge, special, trade_only.

string

Absolute URL for the cover image.

object[]

Nested price rows. Each entry requires currency_code. Optional fields include retail_price, retail_price_inc_tax, list_price, tax_rate, is_default, valid_from, and valid_to (YYYY-MM-DD).

object[]

Nested packing rows. Each entry requires unit_of_measure: inner, outer, or pallet.

object[]

Nested contributor links with contributor_id and contributor_role_id.

object[]

Nested collection membership with collection_id.

object[]

Nested collateral items. Discriminated by collateral_type: text_content, cited_content, or award.

object[]

Custom field values. Each entry has field_id and field_value (string, number, boolean, or null). Duplicate field_id values are rejected.

Response

Returns 201 with the enriched product in data.

boolean

required

true when the product is created.

object

required

Created product, including enriched display fields such as license_name.

Errors

Status	When
`400`	Validation failed, invalid `license_id`, or series not in attached collections
`401`	Missing or invalid API key
`500`	Database or unexpected server error

curl -X POST "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Book Title",
    "subtitle": "An Amazing Story",
    "isbn13": "9781234567890",
    "publishing_status_id": "status-uuid",
    "format_id": "format-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "page_count": 250,
    "publication_date": "2024-12-01"
  }'

{
  "success": true,
  "data": {
    "id": "newly-created-uuid",
    "title": "New Book Title",
    "publishing_status_id": "status-uuid",
    "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "license_name": "Example License",
    "license_badge_colour": "#7C3AED",
    "organization_id": "your-org-id",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Last modified on July 22, 2026

API documentation

Products

Headers

Body

Response

Errors

​Headers

​Body

​Response

​Errors

Headers

Body

Response

Errors