LogoLogo
  • Getting Started
    • Supplier API (ZAPI)
    • Getting Started
      • Implementing Exponential Back-Off
    • API Specification
    • API Specification Enhancements
    • Glossary of Terms
  • Supporting Nodes
    • Supporting Nodes
      • Single Booking Details
      • Currencies
      • Cart
      • Activity Times
      • Products
      • Business Hours
      • Pickup Locations
      • Dropoff Location
      • Rental Date & Times
      • Allowed Guest Types
      • Waitlist
      • Passenger List
      • Guest or Agent Details
      • User Custom Fields
      • Related Bookings
      • Transaction Details
        • Basic Transaction
        • Credit Card Transaction
        • Voucher/Invoice Transaction
        • Discount Transaction
      • Days of the Week
      • Price Code
      • Multi-Day Package Itinerary
      • Booking - Search Results
      • Mobile Data
  • ZAPI Calls
    • Start Here
      • Ping Test
    • Activity Calls
      • All Activities by Date
      • All Activities by Name
      • Activity & Product Catalog
      • Activity Categories
      • Activity Category by ID
      • Cancelled Activities
      • Create Cancellation
      • Check Inventory
      • Single Activity Details
      • Upcoming Activities
      • Remove Cancellation
      • Rental Equipment Calls
        • Equipment Price Quote
        • Equipment Availability
        • Cart Contents
        • Add to Cart
    • Agent Calls
      • Agent Login
      • Authenticate Agent
      • Get Agent Profile
      • Update Agent Username
      • Update Agent Password
    • Booking
      • Batch Availability
      • Booking Search
        • Search Bookings
        • Search by Booking Number
        • Search by Last Name
        • Search by Mobile Number
      • Cancel Booking
      • Email Itinerary
      • Generate Barcode Image
      • Ticket Data by Booking ID
    • Guest Specific
      • Authenticate Guest
      • Booking Details
      • Get Guest Profile
      • Guest Lookup
      • Update Username
      • Update Password
      • Update Profile
    • Interacting with a Cart
      • Add Activity to Cart
      • Add Package to Cart
      • Add Product to Cart
      • Clear Cart Session
      • Create a Unique Cart
      • Get All Cart Sessions
      • Get Cart Contents
      • Load Booking into Cart
      • Remove Activity
      • Remove Product
      • Remove Cart Session
      • Update Notes to Cart
      • Update Customer Details
      • Transactions
        • Process Payment
        • Process Single Transaction
        • Apply Promo Code
        • Apply Gift Card
    • Manifest
      • Entire Day Manifest
      • Activity Manifest
    • Mobile
      • Check In
      • Generate Z Report
      • User Logout
    • Packages
      • Get Package Categories
      • Get Packages by Category
      • Get Package Details
      • Minimum Dates to Book
      • Package Pricing Details
    • Products
      • Product Inventory
      • Product Categories
      • Product by Category
      • Product by Name
      • Single Product Detail
    • System Info
      • All Companies
      • All Equipment
      • Custom Fields List
      • Employee List
      • Get System Info
      • User List
    • Waitlist
      • Single Activity Waitlist
      • Add Guest
      • Convert to Cart
      • Remove Guest
  • Appendix
    • Activity Type IDs
    • Error Codes
    • Package Type IDs
    • Product Type IDs
    • Payment Method Type IDs
    • User Type IDs
Powered by GitBook
On this page

Was this helpful?

  1. ZAPI Calls
  2. Mobile

Check In

Check in a guest or guests for a single activity in a single booking

zapiCheckIn

POST https://{yourdomainname}.zaui.net/zapi/

Request Body

Name
Type
Description

zapiToken*

integer

Token that must be used for a reseller to communicate with the supplier system.

cartId*

integer

Retrieved from running the Agent Login call.

methodName*

string

The method being called

zapiUserId*

integer

Generated by the supplier system when a new contact is created.

zapiAccountId*

integer

Generated by the supplier system.

checkInType*

string

A or a for Activity.

bookingNumber*

integer

Confirmation number assigned once booking is confirmed.

activityId*

integer

ID of the activity to check in.

activityDate*

integer

The travel date. Format: YYYY-MM-DD

toggleStatus*

string

True or False. Default value is True.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiCheckIn</methodName>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[< Checked In > #40248
Guest: Barak Obama

Canyon Icewalk  2022-05-25 13:00:00 2 (ad)  Balance: $0.00]]>
        </methodErrorMessage>
        <bookingBalance>
            <hasOutstandingBalance>false</hasOutstandingBalance>
            <balance>0</balance>
            <balanceFormated>$0.00</balanceFormated>
        </bookingBalance>
        <groupCheckInStatus>1</groupCheckInStatus>
        <messages>
            <message>
                <priorityLevel>
                    <![CDATA[1]]>
                </priorityLevel>
                <title>
                    <![CDATA[< Checked In > #40248]]>
                </title>
                <content>
                    <![CDATA[< Checked In > #40248
Guest: Barak Obama

Canyon Icewalk  2022-05-25 13:00:00 2 (ad) ]]>
                </content>
                <statusCode>
                    <![CDATA[0]]>
                </statusCode>
                <statusMessage>
                    <![CDATA[OK]]>
                </statusMessage>
            </message>
        </messages>
    </methodResponse>
</response>
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiCheckIn</methodName>
		<cartId></cartId>
		<bookingNumber></bookingNumber>
		<checkInType></checkInType>
		<activityId></activityId>
		<activityDate></activityDate>
		<toggleStatus></toggleStatus>
	</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
	<zapiVersion>2.1</zapiVersion>
	<error>0</error>
	<message>OK</message>
	<methodResponse>
		<methodName>zapiCheckIn</methodName>
		<methodErrorCode></methodErrorCode>
		<methodErrorMessage>/methodErrorMessage>
		<bookingBalance>
			<hasOutstandingBalance></hasOutstandingBalance>
			<balance></balance>
			<balanceFormated></balanceFormated>
		</bookingBalance>
	</methodResponse>
</response> 
PreviousMobileNextGenerate Z Report

Last updated 3 years ago

Was this helpful?