Types
Inventory

Create an inventory type

Creates a new inventory type. Unknown fields in the body are rejected.

curl -X POST https://api.faireplace.com/api/types/inventory \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Appliances",
    "description": "Kitchen and home appliances",
    "category_id": "550e8400-e29b-41d4-a716-446655440001",
    "is_active": true
  }'
post/types/inventory

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/types/inventory
  • Auth: HTTP bearer

Request body

namestring required

Name of the inventory type.

descriptionstring nullable

Optional description.

category_idstring uuid nullable

Optional reference to the inventory category.

is_activeboolean

Whether the type is active. Defaults to true when omitted.

Example request

{
  "name": "Appliances",
  "description": "Kitchen and home appliances",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true
}

Response

Inventory type created.

idstring uuid required

Unique inventory type identifier (server-generated).

namestring required

Name of the inventory type.

descriptionstring nullable

Optional description.

category_idstring uuid nullable

Optional reference to the inventory category this type belongs to.

is_activeboolean required

Whether the inventory type is active.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Furniture",
  "description": "Household furniture items",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true,
  "created_at": "2026-06-20T10:30:00",
  "updated_at": "2026-06-20T10:30:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.