{"info":{"_postman_id":"4cc83388-0106-8503-9efd-a0d07b4261b0","name":"Molo Public Booking API","description":"

The Molo Public API is in Beta. Please provide constructive feedback and let us know when you catch something that's totally off, be kind :)

We monitor apisupport@getmolo.com.

Molo's API allows you to:

GET contacts and boats.
POST contacts and boats.
POST to receive availability of \"Offers\" a marina has for space availability and also receive detailed pricing.
GET Marina details such as name, address, phone, and amenities.
POST Offer Holds.
POST reservations prepayments.
Be awesome.

General API Info

Times sent to us and returned back to you are always in UTC.
Molo stores ID's using HashID (http://hashids.org/). Be prepared to receive a string in this field.
Dimensions are sent and received in numeric format. When it comes to converting imperial measurements, remember to convert inches to decimal by divided X/12 inches. Examples: 1 Inch = 0.08, 2 Inches = 0.17, 3 Inches = 0.25, 4 Inches = 0.33, 5 Inches = 0.42, 6 Inches = 0.50, 7 Inches = 0.58, 8 Inches = 0.67. 9 Inches = 0.75, 10 Inches = 0.83, 11 Inches = 0.92

Limits

The API limits are: 120 calls in a 60 second rolling window and a combined 12,000 calls in a rolling 24 hour period.
If you reach your limits, you'll received a 429 response header and a response body that shows when you should re-attempt your call.
If you feel these limits don't work for your needs, email us at apisupport@getmolo.com..

Below is a step-by-step overview of how the Molo API workflow should funtion.

Your Partner token will grant you access to all marinas setup by you and other existing Molo marinas that grant you access to their marina. The Marinas endpoint will list out all the marinas available along with name, address, phone, lat+long, and amenities.
When a user enters arrival, departure, and vessel dimensions in your app, you will find available spaces and pricing with the Offers endpoint.
If a boater decides to move forward with their booking, it will take them some time to complete the checkout process in your app. During that time you will not want them to lose their space. Therefore, you will use the OfferHold endpoint to temporarily hold a space for that boater while they complete the checkout steps in your app. A OfferHold lasts for 15 minutes before expiring.
After a boater completes the checkout process in your app, you will use the Reservations endpoint to POST a reservationt to Molo therefore permanently holding the space. In the Reservations endpoint, you can indicate that payment was already taken by your app.

Offer Types

Below is a list of Offer Types

Transient Dockage / Slip / Berth
Transient Mooring
Transient Side-To / Alongside Dockage
Transient Med Mooring Dockage
Transient Rack Storage
Transient Dry Storage

List of Amenities

This is a list of all the strings Molo uses to identify amenities a marina might have.\nATM, Aviation Fuel, Bait & Tackle, Bank, Clubs/Bars On-Site, Clubs/Bars Nearby, Bath, Beaches, Bikes, Boat Rental, Boat Service Available, Paddleboard/Kayak Rental, Cable TV, Satellite TV, Campground, Charters On-Site, Courtesy Car, Currency Exchange, Deli, Diesel, Disability Access, Dive Shop, Drop-In/Haul-Out Services, Dry Cleaning, Dry Storage, Event Space, Fitness Center, Floating Docks, Gas, Golf Within 5 Miles, Grocery, Grills, Hardware, Health Club, Hotel/Lodging On-Site, Hotel/Lodging Nearby, Hot Tub, Ice, WiFi, Wired Internet, Launch Ramp, Laundry, Lockers, Lounge On-Site, Medical Facilities Within 5 Miles, Newsletter, Oil Recycling, Parking, Pet Friendly, Picnic Area, Playground, Plunge Pool, Post Office Within 1 Mile, Provisions, Pump-Out, Rental Cars, Restaurant On-Site, Restaurant Nearby, Restrooms, Retail Nearby, Salon/Spa, Security, Ship Store, Showers, Snack Shop, Town Nearby, Transportation, Swimming Pool, Tennis, Tiki Bar, Travel Lift, Towing, Water Sport Rental, Water Taxi, Winter Storage, ValvTect

Changelog

This is a reverse chronological log of all changes to the Molo Public API. More to come.

Version 1.6

3-Apr-2018

The Reservation endpoint will now return TransactionId in its response body. This is for future cancellation and refund capabilities of the API.
The Reservation endpoint will also return TransactionTotal which is an echo of the payment you sent that we stored to the TransactionId.
Our response headers used to display Content-Type →text/plain; charset=utf-8. This header has been updated to properly reflect that we respond in JSON

Version 1.5

25-Jan-2018

We refactored the /Offer endpoint for performance improvements.

Version 1.4

22-Jan-2018

The Marina endpoint was updated to return default_arrival_time and default_departure_time as military time strings like 09:30 or 18:00. The times used to be sent as the local time for each marina but are now sent in GMT / UTC time format.

Version 1.3

17-Jan-2018

Issue: Certain POST's to the Boat endpoint could yield a response code of 200 instead of 201 as expected. This issue has been resolved.
Docs were updated to more clearly call out that our API expects a leading zero for military times prior to 12pm.

Version 1.2

11-Jan-2018

Issue: We identified an issue where Slips with Maximum Drafts or Beams with inches that were non-zero weren't being parsed correctly. Thus, you could POST to /Offer and get incorrect availablity when the Beam or Draft were too large. This has been fixed.
Along with the parsing issue above, the API expects 2 decimal places if you collect inches during the booking process from your boaters.

Version 1.1

27-Dec-2017

PowerNeed1 and PowerNeed2 should be sent as an array of string values.
The /Offer endpoint now dynamically updates pricing, availability, and the list of required add-ons depending on what PowerNeed values are sent.
The /OfferHold endpoint checks to see if a space can be held that meet the PowerNeed values sent.
An issue was fixed where the workflow of Offer --> OfferHold --> Reservation would error out at the Reservation step for some marinas with certain PowerNeed values.
The validation of the POST to the Contacts endpoint has been updated. Spaces and non-numeric characters will now be permitted in the country_code and phone fields. They will be stripped out when stored on Molo's side since we dynamically format these numeric values for our users depending on region and country code.

Rate Limit

You may only send 120 requests per minute to our API and 12,000 calls per day.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"General API Info","slug":"general-api-info"},{"content":"Changelog","slug":"changelog"},{"content":"Rate Limit","slug":"rate-limit"}],"owner":"3439648","collectionId":"4cc83388-0106-8503-9efd-a0d07b4261b0","publishedId":"RVfzfox7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1E6286"},"publishDate":"2018-02-21T16:55:01.000Z"},"item":[{"name":"Bearer Token","event":[{"listen":"test","script":{"id":"668af471-a5f2-499e-b138-fb7f38546762","exec":["pm.environment.set(\"prod_public_api_token\", pm.response.json().token);","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"expiresAt\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response time is less than 750ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(750);","});"],"type":"text/javascript"}}],"id":"5599eea3-fd8e-d149-64b0-05a11d1f8d65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"8ac3337e6c144ab0b934505d7d01a751"}],"url":"{{online-booking-url}}v1/api/token?key=ca3ec8b9-370e-47d4-9563-8be7dbb040e4&secret=3381df8a-249b-4982-a189-9ad3298bb1b1","description":"

This method is used to fetch an access token for accessing the API.

When it comes to your secret if you have to ask then you'll never know...

Just messing. Contact us at apisupport@getmolo.com with authentication issues.

\n","urlObject":{"path":["api","token"],"host":["{{online-booking-url}}v1"],"query":[{"key":"key","value":"ca3ec8b9-370e-47d4-9563-8be7dbb040e4"},{"key":"secret","value":"3381df8a-249b-4982-a189-9ad3298bb1b1"}],"variable":[]}},"response":[{"id":"08e3685d-e79a-2fd1-c341-daadd9bcab80","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://molopublicapistage.azure-api.net/v1/api/token"},"code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":""}],"_postman_id":"5599eea3-fd8e-d149-64b0-05a11d1f8d65"},{"name":"Contact","event":[{"listen":"prerequest","script":{"id":"9c371382-69aa-4094-91a7-e51893e5c177","exec":["pm.globals.get(\"token\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"488b98bb-992c-4cf1-af35-edaf192ca4cd","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"molo_contact_id\");","});","","pm.test(\"Response time is less than 350ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(350);","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"2da5f116-f0fb-8be1-475d-e7343c8ac736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"8ac3337e6c144ab0b934505d7d01a751"}],"url":"{{online-booking-url}}v1/api/contact","description":"

This endpooint lets you fetch all contacts linked to your Partner account or just a single contact by HashID.

Add the Contact's HashID at the end of your GET to receive only that contact info.

Example: https://molopublicapistage.azure-api.net/v1/api/Contact?id=Omlo

Molo stores \"contact_id\" as a HashID (http://hashids.org/). Be prepared to receive a string in this field.
\n
We use the \"is_primary\" in address to mark the customer's primary billing address. Other non-primary addresses may be vacation homes or alternate addresses the customer has provided.
\n
Phone Type values are: Home, Work, Mobile, Boat, Home Fax, Work Fax, Boat Fax, Pager, and Other
\n
We store the country code and phone number separately. Moreover, the Phone Number \"phone\" is stored as a numeric value and we add dynamic formatting in the Molo UI. US Example: (###) ###-####
\n

Use this endpoint to add new contacts to Molo or update existing contacts.

POST contact with a NULL \"molo_contact_id\" to make a new contact.
\n
POST with an existing Contact HashID 'molo_contact_id' to update.
\n
We use the 'is_primary' in address to mark the customer's primary billing address. Other non-primary addresses may be vacation homes or alternate addresses the customer has provided.
\n
Phone Type values are: Home, Work, Mobile, Boat, Home Fax, Work Fax, Boat Fax, Pager, and Other
\n
You must send the country code and phone number separately. Moreover, the Phone Number \"phone\" must be sent as a numeric value without spaces or special characters. In the Molo UI, we dynamically format phone numbers. US Example: (###) ###-####
\n
If you are submitting an address, only \"Address Line 2\" is optional.
\n
The \"Zip\" field supports alphanumerics for international zip codes.
\n
For the purposes of sending international addresses from Europe, etc. view this crosswalk below:
\n

City = Town = Province
State = Region = County
Zip = Postal Code

If you leave out any Address or Phone block(s) it will cause those values to be removed from the contact. Therefore, whenever updating a contact, send all contact details in every POST.

Use this endpoint to retrieve boats from Molo.

Possible vessel types: Power, Sail Monohull, Sail Multihull, Kayak, Canoe, PWC, Pontoon, Power Multihull, Dinghy, Paddle Boat, Motoryacht, Megayacht, Sportfish, Ferry, Bowrider, Ski Boat, Cruiser, Speedboat, Barge, Stand-Up Paddleboard, Electric Boat, Center Console, Cuddy, Express Cruiser, Houseboat, Submarine, Towboat, Tugboat, Narrowboat, Water Taxi, Tender, Runabout, Tower Boat, Snowmobile, ATV
\n
For \"dimensions\" we will send \"imperial\" or \"metric\" to indicate the original measurement standard used for the numeric dimensions sent.
\n
Dimensions are in numeric format. Remember to convert inches to decimal by divided X/12 inches.\nExamples: 1 Inch = 0.08, 2 Inches = 0.17, 3 Inches = 0.25, 4 Inches = 0.33, 5 Inches = 0.42, 6 Inches = 0.50, 7 Inches = 0.58, 8 Inches = 0.67. 9 Inches = 0.75, 10 Inches = 0.83, 11 Inches = 0.92
\n
The following fields are optional: Air Draft, Make, Model, Weight, Key Location / Code, Registration Number, Registration State, Hull ID, Color, and Insurance
\n

Add the Boat's HashID at the end of your GET to receive only that boat info. Example with boat Id: http://molopublicapistage.azurewebsites.net/v1/api/boat?id=8WLQ

Add the Contact's HashID at the end of your GET to receive boats that are linked to that contact. Example with boat Id: http://molopublicapistage.azurewebsites.net/v1/api/boat?contactId=ryz4

Use this endpoint to post a boat to Molo.

Important Notes

Omitting molo_vessel_id field will result in a new vessel creation.
\n
POST with a molo_vessel_id to update a vessel.
\n
Possible vessel types: Power, Sail Monohull, Sail Multihull, Kayak, Canoe, PWC, Pontoon, Power Multihull, Dinghy, Paddle Boat, Motoryacht, Megayacht, Sportfish, Ferry, Bowrider, Ski Boat, Cruiser, Speedboat, Barge, Stand-Up Paddleboard, Electric Boat, Center Console, Cuddy, Express Cruiser, Houseboat, Submarine, Towboat, Tugboat, Narrowboat, Water Taxi, Tender, Runabout, Tower Boat, Snowmobile, ATV
\n
For dimensions you must send imperial or metric to indicate the original measurement standard used for the numeric dimensions sent.
\n
Send dimensions in numeric format. Remember to convert inches to decimal by divided X/12 inches.\nExamples: 1 Inch = 0.08, 2 Inches = 0.17, 3 Inches = 0.25, 4 Inches = 0.33, 5 Inches = 0.42, 6 Inches = 0.50, 7 Inches = 0.58, 8 Inches = 0.67. 9 Inches = 0.75, 10 Inches = 0.83, 11 Inches = 0.92
\n
The following fields are optional: Air Draft, Make, Model, Weight, Key Location / Code, Registration Number, Registration State, Hull ID, Color
\n
You must send a Molo Contact ID to indicate to which contact a vessel is linked. If you don't send a relationship, we will default Owner/Captain. Here are the possible relationship values: Owner/Captain, Owner, Captain, Crew, Guest, Co-Owner, Management, Contractor, Secretary/Assistant, First Mate, Engineer, Broker/Agent
\n
All Insurance fields are optional.
\n
When updating vessel, if Insurance fields are empty, the existing insurances linked to vessel will be deleted.
\n
If you include a value for Id in the Insurance block, the existing insurances linked to vessel will be updated.
\n

List of Shore Power

This is a list of all the strings Molo uses to identify shore power a vessel might have.

120 V, 30 Amps
120 V, 50 Amps
120/240 V, 50 Amps
120/240 V, 100 Amps
120/208 V, 100 Amps
408 V, 3 Phase
480 V, Single Phase
480 V, 3 Phase
120/208 V, 100 Amps, 3 Phase
480 V, 200 Amps, 3 Phase
120 V, 20 Amps
120 V /240 V 100 Amps
240 V 200 Amps

Use this endpoint to retrieve a list of marinas.

Important Note: The default_arrival_time and default_departure_time are sent back in UTC / GMT time zone and as military time strings instead of UNIX timestamps.

Add the Marina's HashID at the end of your GET to receive only that marina info.

Example with marina Id: https://https://molopublicapistage.azurewebsites.net/v1/api/Marina?id=Omlo\nExample with region filtering: http://molopublicapistage.azurewebsites.net/v1/api/marina?latMin=-85&latMax=85&longMin=-180&longMax=180

To utilise paging, append an offset and/or limit parameters to the URL e.g. ?offset=100&limit=25.\nAdd the four url parameters to filter marinas by region. If any of the position parameters is left out, the rest will be ignored and API will return marinas without region filtering.

Parameters
- latMin (float) - Minimum value for region Latitude
- latMax (float) - Maximum value for region Latitude
- longMin (float) - Minimum value for region Longitude
- longMax (float) - Maximum value for region Longitude
- limit (int) - Maximum number of results
- offset (int) - Offseting results
\n

Request

Use this endpoint list all available offers. The following are required fields when searching for offers:

Arrival and Departure Date must be provided in UTC.
The Arrival date and time must always be equal to the current date and time or later.
We expect times be military time and have the leading zero for times before 12pm. (E.g. 09:30)
Dimensions is a string of \"imperial\" or \"metric\". It tells us what measurement units are being sent for the vessel dimensions.
Vessel LOA - This is the Length Overall of the vessel. Up to 2 decimal places.
Vessel Beam - This is the width of the vessel. Up to 2 decimal places.
Vessel Draft - This is the depth below the waterline. Up to 2 decimal places.

You can also send some other items in your request to limit the marina offers.

Marina ID - This is optional and you can POST the hash ID of a specific marina location to limit offer availability to that location only.
Min Lat, Max Lat, Min Long, and Max Long - These are shown in the example below and allow you to draw a polygon to restrict the offers to only the marinas in that polygon. Send Lat and Long in decimal format.
Amenities
City
State (2-letter USPS abbreviation)
Zip Code (only first 5 digits for US)
Country

List of Shore Power

This is a list of all the strings Molo uses to identify shore power a space might have.

120 V, 30 Amps
120 V, 50 Amps
120/240 V, 50 Amps
120/240 V, 100 Amps
120/208 V, 100 Amps
408 V, 3 Phase
480 V, Single Phase
480 V, 3 Phase
120/208 V, 100 Amps, 3 Phase
480 V, 200 Amps, 3 Phase
120 V, 20 Amps
120 V / 240 V 100 Amps
240 V 200 Amps

Response

Here is an explanation of the elements of our response:

The StorageSubtotal is the subtotal of dockage fees whether they are flat, per night, or per foot per night.
The Add-OnSubtotal is sum of all required Add-On Total values.
OfferSubtotal is StorageSubtotal + Add-OnSubtotal.
TaxTotal is the total of taxes across storage (dockage) fees and add-ons.
OfferTotal is (OfferSubtotal-AutomaticDiscount>Total) + TaxTotal.

Marina `vg`

Offer `R5p` Example in Stage

Vessel LOA must be less than or equal to 29 feet and 11 inches.
Vessel Draft must be less than or equal to 7 feet.
Length of stay must be between 2 and 10 nights (inclusive).
Earliest arrival is 14-Aug-2017 and latest departure is 31-Oct-2017.
The standard daily rate is $2.25 per foot per night.
Friday and Saturday night are overriden in the offer and will calculate at $2.75 per foot per night through October 28th.
Only 4 spaces exist for this offer.

Offer `RWL` Example in Stage

Vessel LOA must be 30.0 Feet or greater.
Max Beam and Draft are 15 and 10 feet respectively.
Length of stay must be 1 to 20 nights (inclusive).
Earliest arrival is 7-Sep-2017 and latest departure is 18-Oct-2017.
Only 7 spaces exist for this offer. 4 of them overlap with Offer \"R5p\".

Marina `oA`

Important info for all offers at Marina oA:

Length of stay must be 1 to 30 nights (inclusive on min and max).
Latest departure is 1-Jan-2019.
When the vessel is less than 30 feet in length, a minimum standard rate of $60 / night applies to weeknights and a minimum weekend and holiday rate of $67.50 / night applies.
When the vessel is more than 30 feet in length, a standard weeknight rate of $2.00 / foot / night applies and a $2.25 / foot / night rate applies to weekends and holidays.
Below is a list of rate overrides for weekends or holidays. The weekend and holiday rate overrides are applied by night, meaning if the vessel is staying at that marina the night of the date then the rate applies. If the vessel checks out the day a rate override begins, it won't be used to calculate amounts due.

5-Jan-18 6-Jan-18 12-Jan-18 13-Jan-18 19-Jan-18 20-Jan-18 26-Jan-18 27-Jan-18 2-Feb-18 3-Feb-18 9-Feb-18 10-Feb-18 16-Feb-18 17-Feb-18 23-Feb-18 24-Feb-18 2-Mar-18 3-Mar-18 9-Mar-18 10-Mar-18 16-Mar-18 17-Mar-18 23-Mar-18 24-Mar-18 30-Mar-18 31-Mar-18 6-Apr-18 7-Apr-18 13-Apr-18 14-Apr-18 20-Apr-18 21-Apr-18 27-Apr-18 28-Apr-18 4-May-18 5-May-18 11-May-18 12-May-18 18-May-18 19-May-18 25-May-18 28-May-18 1-Jun-18 2-Jun-18 8-Jun-18 9-Jun-18 15-Jun-18 16-Jun-18 22-Jun-18 23-Jun-18 29-Jun-18 4-Jul-18 6-Jul-18 7-Jul-18 13-Jul-18 14-Jul-18 20-Jul-18 21-Jul-18 27-Jul-18 28-Jul-18 3-Aug-18 4-Aug-18 10-Aug-18 11-Aug-18 17-Aug-18 18-Aug-18 24-Aug-18 25-Aug-18 31-Aug-18 3-Sep-18 7-Sep-18 8-Sep-18 14-Sep-18 15-Sep-18 21-Sep-18 22-Sep-18 28-Sep-18 29-Sep-18 5-Oct-18 6-Oct-18 12-Oct-18 13-Oct-18 19-Oct-18 20-Oct-18 26-Oct-18 27-Oct-18 2-Nov-18 3-Nov-18 9-Nov-18 10-Nov-18 16-Nov-18 17-Nov-18 21-Nov-18 26-Nov-18 30-Nov-18 1-Dec-18 7-Dec-18 8-Dec-18 14-Dec-18 15-Dec-18 21-Dec-18 25-Dec-18 28-Dec-18 1-Jan-19

Offer `gmk` Example in Stage

This offer contains 10 slips in total. One of these 10 slips has a long term reservation that will always result in a max of 9 slips available.

Vessel LOA must be 29 feet 11 inches or less.
Max Beam is 13 feet.
One of the available slips has a Max Draft of 4 feet. Three of the other available slips has a Max Draft of 4 feet 9 inches.
All 9 of the 10 that are available can support a single 120 V, 30 Amps.
When you send \"PowerNeed1\":[\"120 V, 30 Amps\"], we will automatically add a $10 / night fee for electricity.

Offer `JqL` Example in Stage

This offer contains 10 slips in total. There are no long term reservations present.

Vessel LOA must be 30 feet or greater and also less than 39 feet 11 inches.
2 of the slips have a Max Beam of 16 feet 6 inches and for the other two the Max Beam is 17 feet.
1 slip has a Max Draft of 5 feet 6 inches, 1 slip has a Max Draft of 6 feet, and for the last 2 slips the Max Draft is 6 feet 6 inches.
All 10 slips are capable of providing 1x 120 V, 30 Amp or 1x 120 V, 50 Amp power.
When you send \"PowerNeed1\":[\"120 V, 50 Amps\"], we will automatically add a $15 / night fee for electricity.

Offer `G19` Example in Stage

This offer contains 10 slips in total.

Vesesl LOA must be 40 feet or greater and also less than 65 feet.
2 slips have a Max Beam of 16 feet 6 inches, 5 slips have a Max Beam of 17 feet, 1 slip has a Max Beam of 18 feet, and the last slip has a Max Beam of 19 feet.
1 slip has a Max Draft of 5 feet 6 inches, 1 slip has a Max Draft of 6 feet, 5 slips have a Max Draft of 6 feet 6 inches, and the final 2 slips have a Max Draft of 7 feet 9 inches.
All 10 slips can accommodate 2x 120 V, 50 Amps Power.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{prod_public_api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4cc83388-0106-8503-9efd-a0d07b4261b0","id":"4cc83388-0106-8503-9efd-a0d07b4261b0","name":"Molo Public Booking API","type":"collection"}},"urlObject":{"path":["api","offer"],"host":["{{online-booking-url}}v1"],"query":[],"variable":[]}},"response":[{"id":"64930bd2-dc88-4985-9519-96ea2fb7a6b7","name":"Check Offer Availability","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false},{"key":"Ocp-Apim-Subscription-Key","value":"8ac3337e6c144ab0b934505d7d01a751","disabled":false}],"body":{"mode":"raw","raw":"{\n \"ArrivalDate\":\"04/06/2018 18:00\",\n \"DepartureDate\":\"04/07/2018 14:00\",\n \"Dimensions\":\"imperial\",\n \"Marina_IDs\":[\"Jo\"],\n \"PowerNeed1\":[\"120 V, 30 Amps\"],\n \"VesselLOA\":55,\n \"VesselBeam\":12,\n \"VesselDraft\":6\n}"},"url":"https://molopublicapi.azure-api.net/v1/api/offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 04 Apr 2018 18:32:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Set-Cookie","value":"ARRAffinity=b83feb1011c0c1fe251a2b7c4cfc96f4857b02c76caebdab729dc2740f535341;Path=/;HttpOnly;Domain=molopublicapiprod.azurewebsites.net","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"[{\"OfferID\":\"DAN\",\"MarinaLocation\":{\"marina_id\":\"Jo\",\"name\":\"Horn Point Harbor Marina\",\"address\":{\"address_line_1\":\"105 Eastern Avenue\",\"address_line_2\":null,\"city\":\"Annapolis\",\"state\":\"MD\",\"zip\":\"21403\"},\"primary_phone_number\":\"410.263.0550\",\"primary_fax_number\":\"410.648.4027\",\"default_tax_rate\":\"6.00\",\"unit_system\":\"imperial\",\"time_zone\":\"(UTC-05:00) Eastern Time (US & Canada)\",\"latitude\":38.969882,\"longitude\":-76.47619,\"marina_website\":null,\"default_arrival_time\":\"10:00\",\"default_departure_time\":\"06:00\",\"amenities\":[]},\"CustomerOfferName\":\"Transient Dockage\",\"ExternalDescription\":null,\"OfferType\":\"Transient Dockage / Slip / Berth\",\"PriceMethod\":\"per foot per night\",\"StandardUnitPrice\":\"2.00\",\"AverageNightlyRate\":\"123.75\",\"SpacesRemaining\":1,\"RateOverrides\":[{\"start_date\":\"4/6/2018\",\"end_date\":\"4/7/2018\",\"rate\":\"2.25\",\"rate_method\":\"per foot per night\"}],\"AddOns\":[{\"AddonName\":\"Electricity, Single 30 Amp, Per Night\",\"Required\":true,\"PricingMethod\":\"per night\",\"UnitPrice\":\"10.00\",\"Total\":\"10.00\",\"Id\":null}],\"StorageSubtotal\":\"123.75\",\"AddOnSubtotal\":\"10.00\",\"OfferSubtotal\":\"133.75\",\"TotalTax\":\"0.00\",\"OfferTotal\":\"133.75\",\"MinimumPayment\":\"133.75\"}]"}],"_postman_id":"262d26ad-4d28-b441-6ab3-65864f80ad5a"},{"name":"Hold Offer for Reservation","event":[{"listen":"prerequest","script":{"id":"62b7fa30-b48f-4af4-8ddc-4bc5740240bd","exec":["pm.globals.get(\"token\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"b5a80f6d-8597-42e0-b043-dda3e2f456bc","exec":["pm.environment.set(\"OfferHoldID\", pm.response.json().OfferHoldID);","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"OfferHoldID\");","});","","pm.test(\"Response time is less than 750ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(750);","});","","pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});"],"type":"text/javascript"}}],"id":"368408f9-4a9c-a1e9-487f-cd7622fce7eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"8ac3337e6c144ab0b934505d7d01a751"}],"body":{"mode":"raw","raw":"{\n \"MarinaID\":\"kg\",\n \"OfferID\":\"ZNZ\",\n \"Dimensions\":\"imperial\",\n \"VesselLOA\":30,\n \"VesselBeam\":8,\n \"VesselDraft\":2,\n \"ArrivalDate\":\"8/7/2021 23:59\",\n\t\"DepartureDate\":\"8/8/2021 14:00\"\n}"},"url":"{{online-booking-url}}v1/api/OfferHold","description":"

Overview

Use this endpoint to hold an offer when a customer begins the booking process in your system. This will hold a space in the offer for 15 minutes while the customer completes the checkout process.

This is an important step to ensure a space is not taken away prior to a customer completing the booking in your platform.

The following must be sent in the OfferHold.

Marina ID - This is the Hash ID of the marina where you are holding a space.
OfferID - This is the Hash ID of the Offer for which you want to hold a space.
Vessel LOA - This is the Length Overall of the vessel. Up to 2 decimal places.
Vessel Beam - This is the width of the vessel. Up to 2 decimal places.
Vessel Draft - This is the depth below the waterline. Up to 2 decimal places.
Scheduled Arrival and Departure Date/time in UTC.
We expect times be military time and have the leading zero for times before 12pm. (E.g. 09:30)
Include your needs for power when asking to hold a space.

List of Shore Power

This is a list of all the strings Molo uses to identify shore power a vessel might have.

120 V, 30 Amps
120 V, 50 Amps
120/240 V, 50 Amps
120/240 V, 100 Amps
120/208 V, 100 Amps
408 V, 3 Phase
480 V, Single Phase
480 V, 3 Phase
120/208 V, 100 Amps, 3 Phase
480 V, 200 Amps, 3 Phase
120 V, 20 Amps
120 V /240 V 100 Amps
240 V 200 Amps

Our Response

Here is an explanation of the elements of our response:

The OfferHoldID is the Hash ID assigned to the held space. You must save this and submit it with your POST to Reservation.
The ExpirationDateTime is a UTC UNIX date/time stamp of when the hold will expire.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{prod_public_api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4cc83388-0106-8503-9efd-a0d07b4261b0","id":"4cc83388-0106-8503-9efd-a0d07b4261b0","name":"Molo Public Booking API","type":"collection"}},"urlObject":{"path":["api","OfferHold"],"host":["{{online-booking-url}}v1"],"query":[],"variable":[]}},"response":[{"id":"0aba2b3b-0625-5ac7-7ed2-3089a1033a06","name":"Hold Offer for Reservation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","name":"Content-Type","value":"application/json","disabled":false},{"key":"Ocp-Apim-Subscription-Key","value":"99297b51b5b64f0c81849d07e57d5be5","disabled":false}],"body":{"mode":"raw","raw":"{\n \"MarinaID\":\"oA\",\n \"OfferID\":\"JqL\",\n \"Dimensions\":\"imperial\",\n \"VesselLOA\":35,\n \"VesselBeam\":4,\n \"VesselDraft\":4,\n\t\"PowerNeed1\": [\"120 V, 30 Amps\"],\n \"ArrivalDate\":\"03/15/2018 18:00\",\n \"DepartureDate\":\"03/16/2018 14:00\"\n}"},"url":"https://molopublicapistage.azurewebsites.net/v1/api/OfferHold"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"68","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/plain; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 17 Jan 2018 15:58:12 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"Set-Cookie","value":"ARRAffinity=eceb174a5b4e7520fd91ad1310012d0a5d1e646197e17e8d9c08b7ab0c0300aa;Path=/;HttpOnly;Domain=molopublicapistage.azurewebsites.net","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"molopublicapistage.azurewebsites.net","path":"/","secure":false,"value":"eceb174a5b4e7520fd91ad1310012d0a5d1e646197e17e8d9c08b7ab0c0300aa","key":"ARRAffinity"}],"responseTime":"1755","body":"{\"OfferHoldID\":\"Mza\",\"ExpirationDateTime\":\"\\/Date(1516205592282)\\/\"}"},{"id":"a84c88e2-ddfd-94fb-0443-93b776f4cea0","name":"Default","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"486d58a6adf04b0ab70f250826c6b941"}],"body":{"mode":"raw","raw":"{\n \"ArrivalDate\": \"01/15/2018 18:00\",\n \"DepartureDate\": \"01/17/2018 14:00\",\n \"Dimensions\": \"imperial\",\n \"Marina_IDs\": [\n \"oA\"\n ],\n \"PowerNeed1\":[\"120 V, 50 Amps\"],\n \"VesselLOA\":35,\n \"VesselBeam\":4,\n \"VesselDraft\":4\n}"},"url":"https://molopublicapistage.azure-api.net/v1/api/offer"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"OfferID\": \"JqL\",\n \"MarinaLocation\": {\n \"marina_id\": \"oA\",\n \"name\": \"Horn Point Harbor Marina\",\n \"address\": {\n \"address_line_1\": \"105 Eastern Avenue\",\n \"address_line_2\": null,\n \"city\": \"Annapolis\",\n \"state\": \"MD\",\n \"zip\": \"21403\"\n },\n \"primary_phone_number\": \"4102630550\",\n \"primary_fax_number\": \"1\",\n \"default_tax_rate\": \"6.00\",\n \"unit_system\": \"imperial\",\n \"time_zone\": \"(UTC-05:00) Eastern Time (US & Canada)\",\n \"latitude\": 38.969882,\n \"longitude\": -76.47619,\n \"marina_website\": null,\n \"default_arrival_time\": \"2018-01-12T15:00:00\",\n \"default_departure_time\": \"2018-01-12T11:00:00\",\n \"amenities\": []\n },\n \"CustomerOfferName\": \"Transient Dockage, Single 50 Amp Electric Service\",\n \"ExternalDescription\": null,\n \"OfferType\": \"Transient Dockage / Slip / Berth\",\n \"PriceMethod\": \"per foot per night\",\n \"StandardUnitPrice\": \"2.00\",\n \"AverageNightlyRate\": \"70.00\",\n \"SpacesRemaining\": 4,\n \"AddOns\": [\n {\n \"AddonName\": \"Electricity, 50 Amp\",\n \"Required\": true,\n \"PricingMethod\": \"per night\",\n \"UnitPrice\": \"15.00\",\n \"Total\": \"30.00\",\n \"Id\": \"kAje\"\n }\n ],\n \"StorageSubtotal\": \"140.00\",\n \"AddOnSubtotal\": \"30.00\",\n \"OfferSubtotal\": \"170.00\",\n \"TotalTax\": \"0.00\",\n \"OfferTotal\": \"170.00\",\n \"MinimumPayment\": \"170.00\"\n }\n]"}],"_postman_id":"368408f9-4a9c-a1e9-487f-cd7622fce7eb"},{"name":"Reservation","event":[{"listen":"prerequest","script":{"id":"82d7a21b-5f21-4a13-b56e-5c9e6fb6fa58","exec":["pm.globals.get(\"token\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"5cb91198-e271-47d0-9474-6ac5c2acbcfa","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"ReservationID\");","});","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"Pending\");","});","","pm.test(\"Response time is less than 1500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1500);","});","","pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});"],"type":"text/javascript"}}],"id":"fdda1040-efb8-7852-51bd-738ed560f399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"8ac3337e6c144ab0b934505d7d01a751"}],"body":{"mode":"raw","raw":" {\n \"MarinaID\":\"kg\",\n \"OfferID\":\"ZNZ\",\n \"OfferHoldID\":\"p8kw0\",\n \"ContactID\":\"NgLa5\",\n \"BoatID\":\"qJll2\",\n \"ScheduledArrivalDate\":\"8/7/2019 23:59\",\n \"ScheduledDepartureDate\":\"8/8/2019 14:00\",\n \"CustomerNotes\":\"I have two other friends docked at this Marina not sure if that matters\",\n\t\"PaymentCollected\":{\"amount\":124.00,\"method\":\"Credit Card\"}\n}"},"url":"{{online-booking-url}}v1/api/Reservation","description":"

Use this endpoint to make a reservation in Molo.

Note: We highly recommend you have an OfferHold in order to make a reservation. If your OfferHold is expired or missing, Molo will attempt to store your reservation but this workflow is not recommended.

The following must be sent in the Reservation POST.

Marina ID - This is the Hash ID of the marina where you are holding a space.
OfferHoldID - This is the Hash ID of the Offer for which you want to hold a space.
ContactID
BoatID
ScheduledArrivalDate - A UTC date/time stamp of the scheduled arrival date. This must be equal to the current date and time or later.
ScheduledDepartureDate - A UTC date/time stamp of the scheduled departure date.
Customer Notes - You can use this to store notes from the customer to the marina.
Payment Block - You can use the to tell Molo how much prepayment was already collected in US Dollars. This will show the marina how much has been paid.
PowerNeed1 and PowerNeed2 should be sent that match the values you used when checking Offer availability. This is helpful because if the OfferHold is recently expired or missing, we can still check to make sure the appropriate power is available prior to saving a reservation.

General API Info

Limits

Offer Types

List of Amenities

Changelog

Version 1.6

Version 1.5

Version 1.4

Version 1.3

Version 1.2

Version 1.1

Rate Limit

Add the Boat's HashID at the end of your GET to receive only that boat info. Example with boat Id: http://molopublicapistage.azurewebsites.net/v1/api/boat?id=8WLQ

Add the Contact's HashID at the end of your GET to receive boats that are linked to that contact. Example with boat Id: http://molopublicapistage.azurewebsites.net/v1/api/boat?contactId=ryz4

Important Notes

List of Shore Power

Request

List of Shore Power

Response

Marina vg

Offer R5p Example in Stage

Offer RWL Example in Stage

Marina oA

Offer gmk Example in Stage

Offer JqL Example in Stage

Offer G19 Example in Stage

Overview

List of Shore Power

Our Response

Marina `vg`

Offer `R5p` Example in Stage

Offer `RWL` Example in Stage

Marina `oA`

Offer `gmk` Example in Stage

Offer `JqL` Example in Stage

Offer `G19` Example in Stage