Skip to main content

Delete Offers

Mutation Overview​

The deleteOffersSetUp mutation is designed to remove offers from hotel rates in Inventory. The returned fields include:

  • success
  • adviseMessages

1. Criteria​

When building your mutation, you need to provide the following input fields:

Mandatory Input​

  • clientCode
  • supplierCode
  • hotelCode
  • rateCode
  • offerCodes

Optional Input​

  • contextCode

2. Settings​

To delete an offer, ensure that all required fields are provided correctly to target the specific offers to be removed.

Response Considerations​

The mutation returns a success status and possible advise messages.

OffersRs (OBJECT)​

  • success (Boolean) - Indicates if the operation was successful.
  • adviseMessages (AdviseMessage) - Messages related to the operation.

Mutation Inputs​

InventoryOffersSetupDeleteInput (INPUT_OBJECT)
Offers setup delete input.

clientCode  *  (String)

Client code.

supplierCode  *  (String)

Travelgate Supplier/Channel code.

offerCodes  *  (String)

Offers codes to delete.

rateCode  *  (String)

Rate Code .

hotelCode  *  (String)

Code associated with the hotel.

contextCode(String)

Context code.

Returned Fields​

OffersRs (OBJECT)
Represents a response object for offers.

adviseMessages(AdviseMessage)

Gets or sets the list of advise messages associated with the offers. See AdviseMessage.

code  *  (ID)

AM code: The following codes can be returned:

description  *  (String)

Error description

level  *  (AdviseMessageLevel)

Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO. Possible values:

  • WARN: Warning message.
  • ERROR: Error message.
  • INFO: Info message.
external(ExternalMessage)

Specify the external message.

code(String)

External code.

message  *  (String)

External message.

correlationID  *  (ID)

Identifier to investigate the cause of the error.

offers(OfferDto)

Gets or sets the list of offers. See OfferDto.

rateCode(String)

The rate code of the offer.

code(String)

The offer code.

isActive  *  (Boolean)

Indicates whether the offer is active.

description(String)

The description of the offer.

nightsType  *  (NightsType)

The type of the offer. Possible values:

  • FIRST: Apply to the first nights.
  • LAST: Apply to the last nights.
  • CHEAPEST: Apply to the cheapest nights.
maxLos(Int)

The maximum length of stay for the offer.

minLos(Int)

The minimum length of stay for the offer.

applyFrom(DateTime)

The start date when the offer applies.

applyTo(DateTime)

The end date when the offer applies.

numberOfNights(Int)

The number of free nights for the offer.

roomCodes(String)

The room codes associated with the offer.

mon(Boolean)

Indicates whether the offer applies on Monday.

tue(Boolean)

Indicates whether the offer applies on Tuesday.

wed(Boolean)

Indicates whether the offer applies on Wednesday.

thu(Boolean)

Indicates whether the offer applies on Thursday.

fri(Boolean)

Indicates whether the offer applies on Friday.

sat(Boolean)

Indicates whether the offer applies on Saturday.

sun(Boolean)

Indicates whether the offer applies on Sunday.

success  *  (Boolean)

Gets a value indicating whether the operation was successful.

Examples​

Delete a Offer​