/tours/{tourId}/callouts/clusters/{clusterType}/action

post

https://api.dev.orbit.do/v5/tours/{tourId}/callouts/clusters/{clusterType}/action

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tourId

string

required

ID of the tour

clusterType

string

required

Type of the cluster

Body Params

action to perform on cluster

type

string

enum

required

Closes the offer round: the winning carrier's callout becomes won and the tour's assign action fires (Unassigned → Assigned). On a MANUAL auction (awardMode: manual) a carrierId is how the operator awards the winner; without one the round ends unassigned and all bids are released. Awarding is only possible until validTill and only while the round is active (400 with a stale-state error otherwise).

Allowed:

price

number

Final price awarded to the winning carrier, in integer cents, EUR (e.g. 115000 = €1,150.00). On a manual auction, omitting it awards at the carrier's own standing bid; awarding a carrier WITHOUT a standing bid requires an explicit price (400 without one).

carrierId

string

Internal Carrier id of the auction winner to award the tour to.

Responses

400

bad request

401

unauthorized

404

tour or cluster not found

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200action performed successfully