SNsnappr
Bookings

Create a photoshoot booking

Creates a photoshoot booking. There are two ways to create one:

  1. Provide all details including start_at. The end-customer is notified once the booking is placed.
  2. Set start_at to null. Snappr contacts the end-customer (email and/or mobile phone) to pick a date and time, and the response includes a scheduling_url they can use. start_at cannot be null when creator_id is set.

Provide either latitude and longitude, or address. If both are provided, only latitude and longitude are used. Booking a time with no available photographer returns a 400 with code NotAvailable; an account without enough credits gets 402 InsufficientCredits.

post/bookings

Request

  • Base URL
    https://api.snappr.com
  • URL
    https://api.snappr.com/bookings
  • Auth
    HTTP bearer

Headers

accept-versionstring

API version. The only version is 1.0.0.

Request body

titlestring

Custom shoot title.

latitudenumber

Latitude of the shoot location. Required together with longitude when address is not provided.

longitudenumber

Longitude of the shoot location. Required together with latitude when address is not provided.

addressstring

Google Maps–valid address of the shoot location. Required when latitude and longitude are not provided.

shoottypestring required

Shoot type name (see listShootTypes), e.g. event.

start_atstring date-time nullable required

Shoot start time in UTC. Must be present; set to null to have the end-customer pick the date and time.

durationinteger required

Shoot length in minutes.

location_notesstring nullable

Details to help the photographer find the location and contact person.

style_notesstring nullable

Instructions, stylistic preferences and special requests.

customer_firstnamestring required
customer_surnamestring nullable
customer_emailstring email required
customer_mobilephonestring required

End-customer's mobile phone number, e.g. +14153339966.

customer_companystring nullable
internal_idstring nullable

Your own identifier, for matching the booking with your data.

creator_idstring uuid nullable

Assign the booking to this specific creator.

tagsstring[] nullable

Tags for finding and reporting on bookings in the Snappr portal. Each tag is lowercased, trimmed and truncated to 255 characters.

Response

Booking created.

uidstring uuid required
package_idstring uuid nullable

The Snappr package (product) the booking was placed on.

titlestring nullable
statusstring required

Booking status, e.g. paid, paid_pending_schedule, completed, cancelled.

creditsinteger required

Credits charged for the booking.

latitudenumber nullable
longitudenumber nullable
shoottypestring nullable
start_atstring date-time nullable
durationinteger nullable

Shoot length in minutes.

location_notesstring nullable
style_notesstring nullable
customer_firstnamestring nullable
customer_surnamestring nullable
customer_emailstring nullable
customer_mobilephonestring nullable
customer_companystring nullable
internal_idstring nullable
creator_namestring nullable

Assigned photographer's first name and last initial.

creator_idstring uuid nullable
creator_profile_image_urlstring uri nullable
created_atstring date-time required
updated_atstring date-time required
update_atstring date-time

Misspelled alias of updated_at, kept for backwards compatibility.

photographer_namestring nullable

Old name for creator_name.

scheduling_urlstring uri

Present when start_at was null. Link the end-customer uses to pick a date and time.

bookingTagsstring[]

The tags stored on the booking (normalised from the request's tags).

Example response

{
  "status": "paid"
}

Changes

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