Pickups

Pickups are locations where customers can be picked up for their experience. Experiences are not required to have pickups. However, when pickups are assigned to experience options, selecting a pickup is required to complete a booking.

Get pickups

SecuritySupplier-production or Supplier-sandbox
Request
header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Responses
200

Pickups

default

Error response

get/supplier/catalog/pickups
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create pickup
SecuritySupplier-production or Supplier-sandbox 
Request 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Request Body schema: application/json
name
required
string
The human-friendly name for the pickup.


 
type
required
string
The type of pickup.


 Enum: Description
HOTEL
The pickup is at a hotel.


MEETING_POINT
The pickup is a general location.


 
latitude
number <float>   [ -90 .. 90 ] 
The latitude value for the pickup location. This value may be omitted.


 
longitude
number <float>   [ -180 .. 180 ] 
The longitude value for the pickup location. This value may be omitted.


 
pickup_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The pickup ID, assigned by the supplier.


 
time_margin
integer <int32> 
 Default:  0
The number of minutes a pickup will occur before or after a time slot. This property accepts both positive and negative values.


A negative value indicates the pickup arrives before the time slot.


A positive value indicates the pickup arrives after the time slot.


 
Responses 
200
Pickup


default
Error response


post/supplier/catalog/pickups
Request samples 
application/json
{
  • "name": "string",
  • "type": "HOTEL",
  • "latitude": -90,
  • "longitude": -180,
  • "pickup_id": "string",
  • "time_margin": 0
}
Response samples 
application/json
{
  • "name": "string",
  • "type": "HOTEL",
  • "latitude": -90,
  • "longitude": -180,
  • "pickup_id": "string",
  • "time_margin": 0
}
Remove pickup
A pickup point cannot be removed if it is part of an availability slot. Suppliers must remove the pickup point from all availability slots first.


SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
pickup_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The pickup ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Responses 
204
Pickup removed successfully


default
Error response


delete/supplier/catalog/pickups/{pickup_id}
Request samples 
Response samples 
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}
Get pickup
SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
pickup_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The pickup ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Responses 
200
Pickup


default
Error response


get/supplier/catalog/pickups/{pickup_id}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "type": "HOTEL",
  • "latitude": -90,
  • "longitude": -180,
  • "pickup_id": "string",
  • "time_margin": 0
}
Copyright © TUI Musement. All rights reserved.