The purpose of this API is to be able to interact with the data collected in the check-in process from our application, whether in android, ios or windows format.
For this we provide some calls that we have tried to make them as accessible and easy as possible.
With this API you can manage everything related to reservations and customers. You will be able to upload incomplete reservations, which will be shown in our APP and carry out the entire checkin process with the reservation data to later collect that reservation with all the necessary data completed, or create them from the APP and collect them later
\nAll data will be sent and received in JSON format.
Gender format is \"10\" for Male and \"20\" for female.
All country fields will be in ISO3 format.
The data is only overwritten if when a field is sent, this field has some value, in any other case the data already inserted will prevail.
\nAll date fields will have the format “YYYY-MM-DD” example: 1879-03-14.
\nThe codes of the types of documents accepted today are:
\nIDC for the identity document
\nPAS for the passport
\nDRI for the driving license
\nEXT for unrecognized documents
\nIn both requests and responses there are several fields to consider. \"reservation_id\" is our internal identification field for the reservation, this field is only consultative, in the same way, the fields \"id\" or \"guest_id\" depending on where they appear, are our internal fields that identify customers and are also consultative.
\nHow can I do to relate the previous internal fields with those of each Product? For reservations, the field is \"pms_reservation_id\" and for customers it is \"pms_guest_id\".
\nThis means that you have to set these fields with the data with the identifiers of your program. Example, for our reservation number 34, it would correspond to your reservation \"BOOK674\", the procedure would be \"reservation_id\" = 34, \"pms_reservation_id\" = \"BOOK674\"
\nThe authentication will use Bearer tokens and will be carried out with the function expressed below. When the token expires, the refresh token function will have to be called.
\nTest keys and a demo endpoint are provided, but the keys to use in production will be sent by us once the validation and verification period as an integrator has ended for the product in question
\nBy setting a Callback URL in the Branch settings of PassportScan Cloud, you will activate a callback system that sends a notification to your URL whenever a guest profile or check-in reservation is modified.
\nExample callback JSON payload:
\n{
\"action\": \"update\",
\"guest_id\": 154354,
\"guest_uuid\": \"9a361d6a-fd68-41cc-ba72-2345950914b9\",
\"hotel_id\": \"e20f1af8\",
\"reservation_id\": 8786,
\"reservation_uuid\": \"2fed52bf-7d3c-4ae2-a887-4273b9b2586e\"
}
The hotel_id corresponds to the first 8 characters of the public key and uniquely identifies the hotel.
\nThis payload is an example of the notification sent to your specified Callback URL whenever changes occur.
\nEndFragment
\nAll error responses will have JSON format where there will be a field called \"code\" that will say the error code and a \"message\" field with associated information
\nIn order to generate a correct token for each account you need the product key that is sent when Passportscan validates the product.
\nThis code is totally private, unique and cannot be shared. Then, for each client that wants to integrate with the product, a public and a private key is needed.
\nThese keys are generated in the configuration of the customer's account and can only be shared to whoever integrates the product.
\nOnce all the information is available, the token is generated. \"public_key\" is the one assigned to each client.
\"product_key\" is the key that identifies the product.
Set reservation is responsible for both creating and updating reservations and customers. Therefore there is 1 field that is mandatory to choose, and that can be, or \"reservation_id\" or \"pms_reservation_id\".
\nIn order of preference, \"pms_reservation_id\" will always be considered before.
\nThis means that if the field exists in the call it will search for a reservation with the same \"pms_reservation_id\", if it finds it, it will overwrite the reservation, otherwise it will create it new. If this field is not sent, \"reservation_id\" will be controlled, if it is found it will overwrite the reservation, otherwise it will throw an error message.
\nThe other fields are optional. In the case that it is a new reservation and \"arrival_date\" is not sent, the day of creation of the client's time slot will be automatically set. If the client is from Sydney, the exact day will be written in Sydney.
\nIf the client is from Lisbon, the exact day will be created in Lisbon. The other fields are optional but the search fields in our APP are \"last_name\", \"first_name\" and / or \"room_number\", if none of these fields are sent you will not be able to search our application.
\n\"Companion\" is an array of customers that are associated with the reservation, it is not mandatory, you can add customers at any time, the fields to be set for the customer and their associated data are the same as \"get_reservation\", and is an array of arrays because in the future more than one associated structure may be needed, for example, more than one address or more than one document
\n","urlObject":{"path":["v1","reservations"],"host":["https://api.passportscan.net"],"query":[],"variable":[]}},"response":[{"id":"2703475f-0123-410e-bc17-7349f18ebc69","name":"set Reservation","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{Token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"group_id\": \"garbage group\",\r\n \"pms_reservation_id\": \"AI387F\",\r\n \"booking_code\": \"345\",\r\n \"arrival_date\": \"2020-02-07\",\r\n \"departure_date\": \"2020-02-17\",\r\n \"adults\": 2,\r\n \"children\": 1,\r\n \"daily_rate\": 60,\r\n \"first_name\": \"Anthony\",\r\n \"last_name\": \"Soprano\",\r\n \"middle_name\": \"John\",\r\n \"travel_agency\": \"East Agency\",\r\n \"group_name\": \"garbage group\",\r\n \"custom_1\": \"custom 1\",\r\n \"custom_2\": \"custom 2\",\r\n \"room_number\": \"F57\",\r\n \"room_type\": \"HIGH\",\r\n \"companion\": [\r\n \t{\r\n \"pms_guest_id\": \"343433\",\r\n \"is_leader\": true,\r\n \"first_name\": \"Anthony\",\r\n \"middle_name\": null,\r\n \"last_name\": \"Soprano\",\r\n \"birth_date\": \"1957-02-15\",\r\n \"birth_nation\": \"USA\",\r\n \"birth_city\": null,\r\n \"birth_province\": null,\r\n \"gender\": \"F\",\r\n \"nationality\": \"USA\",\r\n \"document\" : [\r\n \t{\r\n \t\t\"document_type\": \"IDC\",\r\n \"document_number\": \"787667789\",\r\n \"personal_number\": null,\r\n \"issue_date\": \"1999-01-10\",\r\n \"expiration_date\": \"2013-06-19\",\r\n \"issue_place\": \"North Caldwell\",\r\n \"issue_province\": \"Essex County\",\r\n \"issue_country\": \"USA\"\r\n \t}\r\n \t],\r\n \"contact\": {\r\n \"email\": null,\r\n \"phone\": null\r\n },\r\n \"address\" : [\r\n \t{\r\n \t\t\"address\" : \"14 Aspen\",\r\n \t\t\"city\" : \"North Caldwell\",\r\n \t\t\"province\" : \"Nueva Jersey\",\r\n \t\t\"region\": \"NJ\",\r\n \t\t\"country\" : \"USA\",\r\n \t\t\"zip\" : \"07006\"\r\n \t\t\r\n \t}\r\n \t]\r\n },\r\n {\r\n \"pms_guest_id\": \"C349\",\r\n \"is_leader\": false,\r\n \"first_name\": \"Carmella\",\r\n \"last_name\": \"Soprano\",\r\n \"document\" : [\r\n \t{\r\n \t\t\"issue_place\" : \"North Caldwell\"\r\n \t}\r\n \t]\r\n },\r\n {\r\n \"pms_guest_id\": \"C891\",\r\n \"is_leader\": false,\r\n \"first_name\": \"Meadow\",\r\n \"last_name\": \"Soprano\"\r\n }\r\n ]\r\n }"},"url":"https://api.passportscan.net/v1/reservations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Nov 2022 11:56:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.23.2"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 719630,\n \"account_id\": 330,\n \"reservation_id\": null,\n \"pms_reservation_id\": \"AI387F\",\n \"booking_code\": \"345\",\n \"arrival_date\": \"2020-02-07\",\n \"departure_date\": \"2020-02-17\",\n \"adults\": 2,\n \"children\": 1,\n \"travel_agency\": \"East Agency\",\n \"daily_rate\": null,\n \"group_name\": \"garbage group\",\n \"group_id\": \"garbage group\",\n \"room_number\": \"F57\",\n \"room_type\": \"HIGH\",\n \"first_name\": \"Anthony\",\n \"middle_name\": \"John\",\n \"last_name\": \"Soprano\",\n \"worker_id\": null,\n \"status\": 50,\n \"custom_1\": \"custom 1\",\n \"custom_2\": \"custom 2\",\n \"notes\": null,\n \"source\": \"30\",\n \"integrator_id\": \"AI387F\",\n \"integrator_info\": null,\n \"integrator_last_sync\": \"2021-10-27T09:20:15+00:00\",\n \"is_integration_sync_correct\": true,\n \"customer_reservations\": [\n {\n \"registered_at\": \"2021-10-27T09:20:17+00:00\",\n \"id\": 1553129,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"IDC\",\n \"document_number\": \"787667789\",\n \"personal_number\": null,\n \"issue_date\": \"1999-01-10\",\n \"expiration_date\": \"2013-06-19\",\n \"issue_place\": \"North Caldwell\",\n \"issue_province\": \"Essex County\",\n \"issue_country\": \"USA\",\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2022-11-10T11:56:16+00:00\"\n },\n \"last_address\": {\n \"address\": \"14 Aspen\",\n \"city\": \"North Caldwell\",\n \"province\": \"Nueva Jersey\",\n \"region\": \"NJ\",\n \"zip\": \"07006\",\n \"country\": \"USA\"\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468460,\n \"uuid\": \"34748595-d005-4c90-91d5-df00292555e0\",\n \"first_name\": \"Anthony\",\n \"middle_name\": \"\",\n \"last_name\": \"Soprano\",\n \"name\": \"Anthony Soprano\",\n \"birth_date\": \"1957-02-15\",\n \"age\": 65,\n \"birth_nation\": \"USA\",\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": 20,\n \"nationality\": \"USA\",\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"343433\",\n \"pms_guest_id\": \"343433\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2022-11-10T11:56:16+00:00\"\n },\n \"is_leader\": true,\n \"checkin_time\": null,\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2021-10-27T09:20:17+00:00\"\n },\n {\n \"registered_at\": \"2021-10-27T09:20:19+00:00\",\n \"id\": 1553130,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"EXT\",\n \"document_number\": null,\n \"personal_number\": null,\n \"issue_date\": null,\n \"expiration_date\": null,\n \"issue_place\": \"North Caldwell\",\n \"issue_province\": null,\n \"issue_country\": null,\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2022-11-10T11:56:16+00:00\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": null\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468461,\n \"uuid\": \"06c5d023-a5fa-4ba4-941c-109914f074cf\",\n \"first_name\": \"Carmella\",\n \"middle_name\": null,\n \"last_name\": \"Soprano\",\n \"name\": \"Carmella Soprano\",\n \"birth_date\": null,\n \"age\": 52,\n \"birth_nation\": null,\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": null,\n \"nationality\": null,\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"C349\",\n \"pms_guest_id\": \"C349\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2022-11-10T11:56:16+00:00\"\n },\n \"is_leader\": false,\n \"checkin_time\": null,\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2021-10-27T09:20:19+00:00\"\n },\n {\n \"registered_at\": \"2021-10-27T09:20:21+00:00\",\n \"id\": 1553131,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"EXT\",\n \"document_number\": null,\n \"personal_number\": null,\n \"issue_date\": null,\n \"expiration_date\": null,\n \"issue_place\": null,\n \"issue_province\": null,\n \"issue_country\": null,\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2022-11-10T11:56:17+00:00\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": null\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468462,\n \"uuid\": \"c7263a3a-bf35-4dae-a99d-c38ad6e95d15\",\n \"first_name\": \"Meadow\",\n \"middle_name\": null,\n \"last_name\": \"Soprano\",\n \"name\": \"Meadow Soprano\",\n \"birth_date\": null,\n \"age\": 52,\n \"birth_nation\": null,\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": null,\n \"nationality\": null,\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"C891\",\n \"pms_guest_id\": \"C891\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2022-11-10T11:56:17+00:00\"\n },\n \"is_leader\": false,\n \"checkin_time\": null,\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2021-10-27T09:20:21+00:00\"\n }\n ]\n}"}],"_postman_id":"00f69c84-ca9e-4718-a351-1d2d377b45c6"},{"name":"reservations","id":"c5b29679-3184-4268-b787-faeaae664b1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{Token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.passportscan.net/v1/reservations?arrival_date=2020-02-07&all_customers=1&pagination[page]=1&pagination[limit]=1","description":"This call returns all the information associated with the reservations of the indicated date, so the \"arrival_date\" field is mandatory and we will have to send a correct date. Depending on the value of the \"all_customers\" field, if we set it to \"true\" it will return all the clients of the indicated date. Page filters are important to keep in mind because it can slow down the call if the number of reservations is high.\nIf the \"all_customers\" field is equal to \"false\", the call will only return customers of the date indicated that have been updated in some way, either from the APP, from the web or from or from the \"set\" call since we last called \"get-reservations\", whether we have set the \"all_customers\" field to true or false. This means that if we create the reservation with the customers \"John Locke\" and \"Hugo Reyes\", then we call get-reservations, then we scan the document \"Hugo Reyes\" and call back to get-reservations, we will only return the data of \"Hugo Reyes\"
\n","urlObject":{"path":["v1","reservations"],"host":["https://api.passportscan.net"],"query":[{"key":"arrival_date","value":"2020-02-07"},{"key":"all_customers","value":"1"},{"key":"pagination[page]","value":"1"},{"key":"pagination[limit]","value":"1"}],"variable":[]}},"response":[{"id":"b3410639-e987-402a-a2ca-b812d2be7fc1","name":"reservations","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{Token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.passportscan.net/v1/reservations?arrival_date=2020-02-07&all_customers=1&pagination[page]=1&pagination[limit]=1","host":["https://api.passportscan.net"],"path":["v1","reservations"],"query":[{"key":"arrival_date","value":"2020-02-07"},{"key":"all_customers","value":"1"},{"key":"pagination[page]","value":"1"},{"key":"pagination[limit]","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Nov 2022 11:54:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.23.2"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"count\": 1,\n \"items\": [\n {\n \"id\": 719630,\n \"uuid\": null,\n \"account_id\": 330,\n \"booking_code\": \"345\",\n \"arrival_date\": \"2020-02-07\",\n \"departure_date\": \"2020-02-17\",\n \"adults\": 2,\n \"children\": 1,\n \"travel_agency\": \"East Agency\",\n \"daily_rate\": null,\n \"group_name\": \"garbage group\",\n \"group_id\": \"garbage group\",\n \"room_number\": \"F57\",\n \"room_type\": \"HIGH\",\n \"first_name\": \"Anthony\",\n \"middle_name\": \"John\",\n \"last_name\": \"Soprano\",\n \"customer_reservations\": [\n {\n \"registered_at\": \"2021-10-27T09:20:17+00:00\",\n \"id\": 1553129,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"IDC\",\n \"document_number\": \"787667789\",\n \"personal_number\": null,\n \"issue_date\": \"1999-01-10\",\n \"expiration_date\": \"2013-06-19\",\n \"issue_place\": \"North Caldwell\",\n \"issue_province\": \"Essex County\",\n \"issue_country\": \"USA\",\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2021-10-27T09:20:17+00:00\"\n },\n \"last_address\": {\n \"address\": \"14 Aspen\",\n \"city\": \"North Caldwell\",\n \"province\": \"Nueva Jersey\",\n \"region\": \"NJ\",\n \"zip\": \"07006\",\n \"country\": \"USA\"\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468460,\n \"uuid\": null,\n \"first_name\": \"Anthony\",\n \"middle_name\": null,\n \"last_name\": \"Soprano\",\n \"name\": \"Anthony Soprano\",\n \"birth_date\": \"1957-02-15\",\n \"age\": 65,\n \"birth_nation\": \"USA\",\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": \"F\",\n \"nationality\": \"USA\",\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"343433\",\n \"pms_guest_id\": \"343433\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2021-10-27T09:20:17+00:00\",\n \"is_leader\": true,\n \"checkin_time\": null\n },\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:17+00:00\",\n \"updated_at\": \"2021-10-27T09:20:17+00:00\"\n },\n {\n \"registered_at\": \"2021-10-27T09:20:19+00:00\",\n \"id\": 1553130,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"EXT\",\n \"document_number\": null,\n \"personal_number\": null,\n \"issue_date\": null,\n \"expiration_date\": null,\n \"issue_place\": \"North Caldwell\",\n \"issue_province\": null,\n \"issue_country\": null,\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2021-10-27T09:20:19+00:00\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": null\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468461,\n \"uuid\": null,\n \"first_name\": \"Carmella\",\n \"middle_name\": null,\n \"last_name\": \"Soprano\",\n \"name\": \"Carmella Soprano\",\n \"birth_date\": null,\n \"age\": 52,\n \"birth_nation\": null,\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": null,\n \"nationality\": null,\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"C349\",\n \"pms_guest_id\": \"C349\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2021-10-27T09:20:19+00:00\",\n \"is_leader\": false,\n \"checkin_time\": null\n },\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:19+00:00\",\n \"updated_at\": \"2021-10-27T09:20:19+00:00\"\n },\n {\n \"registered_at\": \"2021-10-27T09:20:21+00:00\",\n \"id\": 1553131,\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"EXT\",\n \"document_number\": null,\n \"personal_number\": null,\n \"issue_date\": null,\n \"expiration_date\": null,\n \"issue_place\": null,\n \"issue_province\": null,\n \"issue_country\": null,\n \"photo_id\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2021-10-27T09:20:21+00:00\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": null\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 1468462,\n \"uuid\": null,\n \"first_name\": \"Meadow\",\n \"middle_name\": null,\n \"last_name\": \"Soprano\",\n \"name\": \"Meadow Soprano\",\n \"birth_date\": null,\n \"age\": 52,\n \"birth_nation\": null,\n \"birth_city\": null,\n \"birth_province\": null,\n \"gender\": null,\n \"nationality\": null,\n \"worker_id\": 0,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"C891\",\n \"pms_guest_id\": \"C891\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2021-10-27T09:20:21+00:00\",\n \"is_leader\": false,\n \"checkin_time\": null\n },\n \"source\": null,\n \"created_at\": \"2021-10-27T09:20:21+00:00\",\n \"updated_at\": \"2021-10-27T09:20:21+00:00\"\n }\n ],\n \"status\": 50,\n \"credit_card_status\": 60,\n \"custom_1\": \"custom 1\",\n \"custom_2\": \"custom 2\",\n \"notes\": null,\n \"source\": 30,\n \"integrator_id\": \"AI387F\",\n \"pms_reservation_id\": \"AI387F\",\n \"integrator_info\": null,\n \"integrator_last_sync\": \"2021-10-27T09:20:15+00:00\",\n \"is_integration_sync_correct\": true,\n \"created_at\": \"2021-10-27T09:20:15+00:00\",\n \"updated_at\": \"2021-10-27T09:20:15+00:00\"\n }\n ],\n \"_links\": {\n \"self\": \"/v1/reservation?filters%5Barrival_date%5D=2020-02-07&filters%5Ball_customers%5D=1&filters%5Bcontext%5D=reservation_short&filters%5Baccount_id%5D=330&pagination%5Bpage%5D=1&pagination%5Blimit%5D=1\",\n \"first\": \"/v1/reservation?filters%5Barrival_date%5D=2020-02-07&filters%5Ball_customers%5D=1&filters%5Bcontext%5D=reservation_short&filters%5Baccount_id%5D=330&pagination%5Bpage%5D=1&pagination%5Blimit%5D=1\",\n \"last\": \"/v1/reservation?filters%5Barrival_date%5D=2020-02-07&filters%5Ball_customers%5D=1&filters%5Bcontext%5D=reservation_short&filters%5Baccount_id%5D=330&pagination%5Bpage%5D=1&pagination%5Blimit%5D=1\"\n }\n}"}],"_postman_id":"c5b29679-3184-4268-b787-faeaae664b1d"},{"name":"reservation","id":"f455bbb7-cf03-468d-9777-5c9dc8a46f24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{Token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.passportscan.net/v1/reservations/get-reservation?reservation_id=719630","description":"This call returns all the information associated with one reservation and their customers. In the example, get parameter is \"reservation_id\", which is our internal id for the reservation, but it can be sent the parameter \"pms_reservation_id\", which is the identifier of your PMS
\n","urlObject":{"path":["v1","reservations","get-reservation"],"host":["https://api.passportscan.net"],"query":[{"key":"reservation_id","value":"719630"}],"variable":[]}},"response":[{"id":"c72a7342-e53a-4276-a06f-305354941c02","name":"get reservation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{Token}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.passportscan.net/v1/reservations/get-reservation?reservation_id=7665620","host":["https://api.passportscan.net"],"path":["v1","reservations","get-reservation"],"query":[{"key":"reservation_id","value":"7665620"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2024 10:24:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.25.5"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7665620,\n \"uuid\": \"cf97b213-1619-4644-b4f6-d6b02c38d002\",\n \"account_id\": 119,\n \"booking_code\": \"565656\",\n \"arrival_date\": \"2024-05-28\",\n \"departure_date\": \"2024-05-29\",\n \"adults\": 2,\n \"children\": 0,\n \"travel_agency\": null,\n \"daily_rate\": null,\n \"group_name\": null,\n \"group_id\": null,\n \"room_number\": null,\n \"room_type\": null,\n \"first_name\": \"Pippo\",\n \"middle_name\": null,\n \"last_name\": \"Prova\",\n \"customer_reservations\": [\n {\n \"registered_at\": \"2024-05-28T14:21:40+00:00\",\n \"id\": 13849375,\n \"uuid\": \"0b4d5b18-688f-4a1a-827d-bfb1580d4b84\",\n \"customer\": {\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"PAS\",\n \"document_number\": \"YB7450041\",\n \"personal_number\": null,\n \"issue_date\": \"2020-08-21\",\n \"expiration_date\": \"2030-08-20\",\n \"issue_place\": \"Gravedona ed Uniti\",\n \"issue_province\": \"CO\",\n \"issue_country\": \"ITA\",\n \"photo_id\": \"51141079\",\n \"created_at\": \"2024-02-02T10:17:03+00:00\",\n \"updated_at\": \"2024-05-28T14:21:40+00:00\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": \"ITA\"\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 11137703,\n \"uuid\": \"0e0524e4-423b-4380-a9e3-1010ba12a0ba\",\n \"first_name\": \"Davide.\",\n \"middle_name\": \"\",\n \"last_name\": \"Palo\",\n \"title\": null,\n \"language\": null,\n \"name\": \"Davide. Palo\",\n \"birth_date\": \"1969-07-28\",\n \"age\": 55,\n \"birth_nation\": \"ITA\",\n \"birth_city\": \"Gravedona ed Uniti\",\n \"birth_province\": \"CO\",\n \"gender\": 10,\n \"nationality\": \"ITA\",\n \"worker_id\": 108,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"31904\",\n \"pms_guest_id\": \"31904\",\n \"pms_reservation_id\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2024-02-02T10:17:03+00:00\",\n \"updated_at\": \"2024-05-28T14:21:40+00:00\"\n },\n \"is_leader\": false,\n \"no_police\": false,\n \"checkin_time\": null,\n \"source\": 20,\n \"created_at\": \"2024-05-28T14:21:40+00:00\",\n \"updated_at\": \"2024-05-28T14:21:40+00:00\"\n }\n ],\n \"status\": 50,\n \"credit_card_status\": 60,\n \"custom_1\": null,\n \"custom_2\": null,\n \"notes\": null,\n \"source\": 10,\n \"integrator_id\": null,\n \"pms_reservation_id\": null,\n \"integrator_info\": null,\n \"integrator_last_sync\": null,\n \"is_integration_sync_correct\": null,\n \"created_at\": \"2024-05-28T14:20:56+00:00\",\n \"updated_at\": \"2024-05-28T14:20:56+00:00\"\n}"}],"_postman_id":"f455bbb7-cf03-468d-9777-5c9dc8a46f24"},{"name":"customers","id":"62fd9e44-d4f7-41dc-9e1b-9364976b5121","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{Token}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.passportscan.net/v1/customers/11137703","description":"This call returns all the information associated with one customer.
\n","urlObject":{"path":["v1","customers","11137703"],"host":["https://api.passportscan.net"],"query":[],"variable":[]}},"response":[{"id":"b8119e0c-7435-4443-b143-ae423e1bb551","name":"customers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{Token}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.passportscan.net/v1/customers/11137703"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2024 10:24:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.25.5"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"full_name\": null,\n \"last_document\": {\n \"document_type\": \"PAS\",\n \"document_number\": \"YB7450041\",\n \"personal_number\": null,\n \"issue_date\": \"2020-08-21\",\n \"expiration_date\": \"2030-08-20\",\n \"issue_place\": \"Gravedona ed Uniti\",\n \"issue_province\": \"CO\",\n \"issue_country\": \"ITA\"\n },\n \"last_address\": {\n \"address\": null,\n \"city\": null,\n \"province\": null,\n \"region\": null,\n \"zip\": null,\n \"country\": \"ITA\"\n },\n \"last_contact\": {\n \"email\": null,\n \"phone\": null\n },\n \"success_syncronize\": true,\n \"privacy_flags\": {\n \"market_research\": null,\n \"third_parties\": null,\n \"loyalty_program\": null,\n \"promotions\": null,\n \"privacy\": null,\n \"email\": null,\n \"mail\": null,\n \"phone\": null,\n \"sms\": null\n },\n \"id\": 11137703,\n \"uuid\": \"0e0524e4-423b-4380-a9e3-1010ba12a0ba\",\n \"first_name\": \"Davide.\",\n \"middle_name\": \"\",\n \"last_name\": \"Palo\",\n \"title\": null,\n \"language\": null,\n \"name\": \"Davide. Palo\",\n \"birth_date\": \"1969-07-28\",\n \"age\": 55,\n \"birth_nation\": \"ITA\",\n \"birth_city\": \"Gravedona ed Uniti\",\n \"birth_province\": \"CO\",\n \"gender\": 10,\n \"nationality\": \"ITA\",\n \"worker_id\": 108,\n \"bad_recognized\": false,\n \"integrator_info\": null,\n \"integrator_id\": \"31904\",\n \"pms_guest_id\": \"31904\",\n \"pms_reservation_id\": null,\n \"integrator_last_sync\": \"2024-05-20T11:19:38+00:00\",\n \"photo_id\": 51141079\n}"}],"_postman_id":"62fd9e44-d4f7-41dc-9e1b-9364976b5121"},{"name":"delete reservation","id":"9ad35022-835e-4ae1-a7ec-1c112eca2907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{Token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"reservation_id\" : \"1602\"\n}"},"url":"https://api.passportscan.net/v1/reservations","description":"This request will delete the reservation and the relationship associated with the clients, but will not delete the clients as they may be associated with other previous or subsequent reservations.\nIt can be used interchangeably to clear the reservation both the \"reservation_id\" field and the \"pms_reservation_id\" field
\n","urlObject":{"path":["v1","reservations"],"host":["https://api.passportscan.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ad35022-835e-4ae1-a7ec-1c112eca2907"},{"name":"set pms guest id","id":"8435e5fc-050f-46e3-824d-a86b67dcddd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9pZGVudGl0eSIsImF1ZCI6Imh0dHA6XC9cL2lkZW50aXR5IiwiaWF0IjoxNTgxMDkyMjU4LCJuYmYiOjE1ODEwOTIyNTgsImV4cCI6MTU4MzU5Nzg1OCwiMCI6IkF1dGhvcml6YXRpb24iLCJqdGkiOjAsInVzZXJfaWQiOjAsInVzZXJuYW1lIjoiU0VSVklDRV9BQ0NPVU5UIiwiY3VzdG9tZXJfaWQiOjU3LCJhY2NvdW50X2lkIjo2OSwicm9sZXMiOlsiUk9MRV9VU0VSIiwiUk9MRV9MSU5LRURfQlJBTkNIIiwiUk9MRV9TRVJWSUNFIl0sInByb2R1Y3Rfa2V5IjoiYmMwNTM5NDMtMDVjZS00YWZiLTg0MzAtYThkODIzN2M2NzFhIn0.0O7PeZFATu10Ub0dv0pXcGoNCI2VO5UNjF9dW1tgXok"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"pms_reservation_id\": \"your PMS reservation id\",\n\t\"id\": \"Our internal id returned in get-reservation\",\n\t\"pms_guest_id\": \"your PMS guest id\"\n}"},"url":"https://api.passportscan.net/v1/reservations/set-pms-guest-id","description":"In some situation, you may not have the reservation pms_guest_id until after creating the reservation but you need to create the reservation. In this case we can update it by sending the id that we received from the client when creating the reservation. For requirements in some use cases, the pms_reservation_id field will also be required to relate the reservation to the client.
\n","urlObject":{"path":["v1","reservations","set-pms-guest-id"],"host":["https://api.passportscan.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"8435e5fc-050f-46e3-824d-a86b67dcddd5"}],"id":"4c7553a0-1296-438f-af4d-68ab45bf030f","_postman_id":"4c7553a0-1296-438f-af4d-68ab45bf030f","description":""}],"event":[{"listen":"prerequest","script":{"id":"ab3b1ae6-c494-4707-9dc0-d2e959575386","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77835246-22c6-4156-80b3-ddea169e2b71","type":"text/javascript","exec":[""]}}],"variable":[{"id":"bf1820f9-17a1-4acf-a461-720093e8242f","key":"endpoint","value":"http://localhost:8199"},{"id":"0584567c-9050-4666-ae60-b8d136a457d3","key":"endpoint_dev","value":"https://api.psm-dev.tasdemos.com"},{"id":"280004c8-24da-4dee-9fa8-83f03b61164d","key":"service_token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9pZGVudGl0eSIsImF1ZCI6Imh0dHA6XC9cL2lkZW50aXR5IiwiaWF0IjoxNTgxMDkyMjU4LCJuYmYiOjE1ODEwOTIyNTgsImV4cCI6MTU4MzU5Nzg1OCwiMCI6IkF1dGhvcml6YXRpb24iLCJqdGkiOjAsInVzZXJfaWQiOjAsInVzZXJuYW1lIjoiU0VSVklDRV9BQ0NPVU5UIiwiY3VzdG9tZXJfaWQiOjU3LCJhY2NvdW50X2lkIjo2OSwicm9sZXMiOlsiUk9MRV9VU0VSIiwiUk9MRV9MSU5LRURfQlJBTkNIIiwiUk9MRV9TRVJWSUNFIl0sInByb2R1Y3Rfa2V5IjoiYmMwNTM5NDMtMDVjZS00YWZiLTg0MzAtYThkODIzN2M2NzFhIn0.0O7PeZFATu10Ub0dv0pXcGoNCI2VO5UNjF9dW1tgXok"},{"id":"c81b7956-18ec-4f0b-8326-aeff66b6bf3f","key":"endpoint_prod","value":"https://api.passportscan.net"}]}