Availability and rates APIs
Booking APIs
Property mgmt APIs
Developer Tools
Sandbox API
MutationsSandbox API

deleteReservation mutation

Deletes a reservation for a specified sandbox property.

Note: This operation will permanently delete the reservation for the specified property and cannot be reversed.

Syntax

1mutation {
2  deleteReservation(input: DeleteReservationInput!): DeleteReservationPayload!    
3}

Example

1mutation { 
2 deleteReservation(input: { 
3   id: "100000012" 
4 }) { 
5   clientMutationId 
6  } 
7}

Arguments

NameDescription

input

Required.
Type: DeleteReservationInput

Types


Name
Type
DeleteReservationInput
InputObject

Input object for deleting a reservation.

FieldDescription
clientMutationId

Partner's transaction ID that uniquely identifies the request, which can be used to associate requests and responses for troubleshooting purposes. This ID must be unique across requests and cannot be reused. However, if a request needs to be retried, such as because it failed or timed out, the ID provided in the original request should be used. The ID can be in any format as long as it uniquely identifies the request.

Type: String
idNot nullable.

ID of the reservation to delete.

Type: ID
DeleteReservationPayload
Object

Response payload for the deleteReservation mutation.

FieldDescription
clientMutationId

Partner's transaction ID that identifies the request, which can be used to correlate with partner's transaction logs. This ID must be unique across requests and cannot be reused.

Type: String
ID
ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

String
String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.