API - Availability & Pricing API Endpoint

      Availability & Pricing API Endpoint

      If you're checking availability across a large volume of items or times, we recommend running your checks using the speedy flag first. If the speedy check returns an uncertain result, you can then fall back to the standard method to confirm.

      1. Overview & Purpose

      • Summary: Overview of the API6 Availability and Pricing endpoint used to check item availability and calculate rental pricing dynamically.
      • Intended Audience: Developers integrating custom booking systems, storefronts, or custom web forms with InflatableOffice.
      • Authentication & Base URL: Standard API6 authentication headers and endpoint route.

      2. Request Specifications

      • HTTP Method:
      • POST
        			
      • Endpoint Path /api6/availability-pricing

        (or finalized endpoint path)

      • Headers: Content-Type: application/json

        , API authentication tokens/headers.

      • Request Body Parameters:
        • start
          				

          (long / timestamp, required): Start time (Unix timestamp in milliseconds).

        • end
          				

          (long / timestamp, required): End time (Unix timestamp in milliseconds).

        • location_id
          				

          (integer, optional): Specific inventory location ID (default:0).

        • delivery_type
          				

          (string, optional): e.g.,

          "Delivery"
          				

          or

          "Customer Pickup"
          				

          .

        • items
          				

          (array of objects, required):

          • rental_id
            					

            (integer, required): Unique rental item ID.

          • quantity
            					

            (integer, required): Desired quantity. accessories

          • (array, optional): Associated accessory IDs/quantities.

        • multi-date
          				

          (array of objects, optional): Additional date ranges

          [{"start": ..., "end": ...}]
          				

          to check multiple slots in a single call.

        • speedy
          				

          (boolean, optional, default:

          false
          				

      Enable fast availability checking mode for high-volume queries.


      3. Availability Modes & Best Practices

      • Standard vs. Speedy Mode:
        • Standard Mode speedy: false

           Performs a full, comprehensive availability evaluation across all conflict rules and active leads.

        • Speedy Mode  speedy: true

           Optimized lightweight query ideal for checking availability across multiple dates or large catalogs simultaneously.

      • Recommended Workflow & Fallback Logic:
        • Use speedy: true

          for broad catalog browsing and multi-date inquiries.

        • If a response returns unsure

          or

          possibly unavailable
          				

           Trigger a secondary targeted request with

          speedy: false
          				

          before declining the booking.


      4. Pricing & Rule Calculations

      • Base Pricing vs Conditional Rules: Explanation of how prices are calculated.
      • Multi-Date Optimization: How identical pricing is reused across dates when no conditional filter rules apply.

      5. Sample Request & Response Payloads

      • Single-Date Standard Check:
        • Sample JSON Request & 200 OK Response
      • Multi-Date Speedy Check:
        • Sample JSON Request with <pre>multi-date

          array &

        • speedy: true
          				
        • Sample Response demonstrating per-date availability status breakdown 
          available


          unavailable
          				


          unsure
          				



      6. Error Handling & Response Codes

      Common HTTP status codes 200 OK

      • 400 Bad Request
        			


        401 Unauthorized
        			


        422 Unprocessable Entity
        			


      • Error payload schemas and troubleshooting invalid date ranges or missing rental IDs.
Is this article helpful?
0 0 0