Updates a pickup list. This service should not be used for partial updates. A full pickup list object with the desired pick up locations should be passed as input

Request

PUT https://api.rezdy.com/v1/pickups/{pickupListId}

Path parameters

Parameter name Value Description Additional
pickupListId int64

Pickup list ID

Required

Request body

The request body takes a complete PickupList resource, containing the following writable properties:

{
    "additionalNotes": "string",
    "id": "int64",
    "name": "string",
    "otherLocationInstructions": "string",
    "pickupLocations": [
        {
            "additionalInstructions": "string",
            "address": "string",
            "latitude": "double",
            "locationName": "string",
            "longitude": "double",
            "minutesPrior": "int32",
            "pickupInstructions": "string",
            "pickupTime": "string"
        }
    ]
}

Properties

Name Type Description Additional
additionalNotes string

Global additional instructions for this pick up list

Optional
id int64

ID of this pickup

Optional
name string

Name of the pickup location list

Optional
otherLocationInstructions string

Instructions for other locations that are not available in the pickupLocations list. E.g. For customer pick up location requests, a sample instruction for this field would be: 'We will contact you to confirm your pickup location'

Optional
pickupLocations[] array

List of all associated pickup locations for this list

Optional
pickupLocations[].additionalInstructions string

Additional instructions for the pickup location.

Optional
pickupLocations[].address string

Address of the pickup location
In a booking item object, it represents a chosen pickup address for the booked item.

Optional
pickupLocations[].latitude double

google maps calculated latitude of the pickup address

Optional
pickupLocations[].locationName string

Pickup location name - free text name for the location.

In a booking item object, it represents customer's pickup location name (if configured on product). It can be one name from pickup locations list of the booked product, or free text in case of the other pickup location option.

The value will be ignored, if the product does not allow pickups or if the location name does not match one of the product's pickup locations and 'other' pickup option is not enabled for the product pickup.

Optional
pickupLocations[].longitude double

google maps calculated latitude of the pickup address

Optional
pickupLocations[].minutesPrior int32

Pickup time in minutes, prior to the tour start time.

Optional
pickupLocations[].pickupInstructions string

Present only in booking service response

Chosen pickup instructions (general and location specific). Shown when the pickup was chosen for the booked item.

Optional
pickupLocations[].pickupTime string

Present only in booking service response

In a booking item object, it represents a calculated pickup time, in supplier's local timezone. Shown when the pickup was chosen for the booked item and pickup location contains duration.

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ResponseProduct

Explore this API

apiKey Enter your API Key to try this call
pickupListId

Pickup list ID

body

Modified pickup list

Request Content-Type
Response Content-Type
Try it out!