Product Entity

Products define the video and photo packages available for sale at your dropzone. Each product specifies what content types are included (photos, video types, etc.) and can be matched to bookings from external booking systems.

Fields

Basic Fields

Field Type Required Description
id integer Yes Unique identifier for the product
name string Yes Display name of the product
active boolean Yes Whether the product is currently available for sale
booking_system_name string No Name used to match this product with bookings from external systems (case-insensitive)
price_cents integer No Price in cents (smallest currency unit)
created_at datetime Yes When the product was created
updated_at datetime Yes When the product was last updated

Content Entitlements

These fields define what content is included in the product:

Field Type Required Description
photos boolean Yes Includes still photos from the jump
video_entitlement string Yes Which video the product entitles (see Video Entitlement below)
camera_requirement string \ null Yes
has_4k boolean Yes Includes 4K resolution video
raw_footage boolean Yes Includes unedited raw footage files

Deprecated Fields

These boolean fields are still returned for backwards compatibility but are deprecated. They are derived from video_entitlement and camera_requirement — use those fields instead.

Field Type Required Description
selfie boolean Yes Includes selfie/handcam video. Derived from camera_requirement/video_entitlement
videographer boolean Yes Includes outside videographer footage. Derived from camera_requirement/video_entitlement
either_video boolean Yes Customer can choose either video type. Derived from camera_requirement/video_entitlement
socials boolean Yes Includes social media optimized video clips. Derived from video_entitlement

Video Entitlement

video_entitlement describes which video(s) the product entitles. It supersedes the deprecated socials boolean (socials is true only when video_entitlement is all).

Value Description
none No video entitlement (e.g. a photos-only product)
all All video formats, including social media clips
main Main edit only
highlights Highlights edit only
insta Instagram clip only
freefall Freefall edit only

Camera Requirement

camera_requirement describes which camera the entitled video must come from. It supersedes the deprecated selfie, videographer and either_video booleans.

Value Description
either Either camera is acceptable (maps to deprecated either_video)
selfie Selfie/handcam camera (maps to deprecated selfie)
videographer Videographer camera (maps to deprecated videographer)
both Both cameras required — combo/VIP (maps to deprecated selfie and videographer)

Example

{
  "id": 1,
  "name": "Video & Photos Package",
  "active": true,
  "booking_system_name": "video_photos",
  "price_cents": 15000,
  "photos": true,
  "video_entitlement": "all",
  "camera_requirement": "videographer",
  "has_4k": false,
  "raw_footage": false,
  "selfie": false,
  "videographer": true,
  "either_video": false,
  "socials": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Notes

  • Products are matched to bookings using the booking_system_name field
  • The booking_system_name matching is case-insensitive and matches by prefix
  • Products are read-only via the API - they must be configured in the FFF admin interface