Travel.Flights.OrderChangeRequests (travel v0.2.0)

Copy Markdown View Source

Create and retrieve order change requests (PREVIEW).

Endpoints

  • POST /air/order_change_requests - Create a change request
  • GET /air/order_change_requests/{id} - Get a change request

Examples

# Create a change request
{:ok, response} = Travel.Flights.OrderChangeRequests.create(%{
  order_id: "ord_123",
  slices: %{
    add: [%{origin: "LHR", destination: "CDG", departure_date: "2025-07-01"}],
    remove: [%{slice_id: "sli_123"}]
  }
})

@link https://duffel.com/docs/api/order-change-requests

Summary

Functions

create(params)

Create an order change request.

get(change_request_id)

Get a change request by ID.

Functions

create(params)

@spec create(map()) ::
  {:ok, Travel.Types.DuffelResponse.t()} | {:error, Travel.Error.t() | term()}

Create an order change request.

Parameters

  • params - Change request parameters:
    • :order_id - (required) The order ID to change
    • :slices - (required) Map with add and remove slice lists

Returns

  • {:ok, %Travel.Types.DuffelResponse{data: %Types.OrderChangeRequestResponse{}}} on success
  • {:error, %Travel.Error{}} on failure

get(change_request_id)

@spec get(String.t()) ::
  {:ok, Travel.Types.DuffelResponse.t()} | {:error, Travel.Error.t() | term()}

Get a change request by ID.

Parameters

  • change_request_id - The change request ID

Returns

  • {:ok, %Travel.Types.DuffelResponse{data: %Types.OrderChangeRequestResponse{}}} on success
  • {:error, %Travel.Error{}} on failure