Skip to content

Get offer

GET/offers/{id}

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/transfercompanies

Retrieves a specific offer by id

Returns one offer with the journey details, the fare you would be paid, the meeting points you can choose from and its expiry. Traveller names and contact details are only shared once you accept.

Guide: Accept or decline offers

Path parameters

  • idinteger · int64required

    The id of the offer to retrieve

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Responses

OK

  • idinteger · int64

    Offer id; use it to accept or decline.

  • preferredboolean

    True when your company is a preferred supplier for this journey.

  • fleetobject

    The fleet the offer is for.

  • journeyobject

    The offered journey, without personal traveller details.

  • meetingPointsarray of objects

    Meeting points you can choose from when accepting.

  • addonsPerQuantityarray of objects
  • meetingPointRequiredboolean

    When true, send a meetingPointId when accepting.

  • expirystring · date-time

    Accept or decline before this time.

  • statusenum

    Status of the offer.

    PENDING
    Created, not yet sent to the transfer company.
    NOTIFIED
    Sent to the transfer company; it can be accepted or declined.
    SKIPPED_NOTIFICATION
    Created without a notification being sent.
    ACCEPTED
    Accepted by this transfer company.
    DECLINED
    Declined by this transfer company.
    EXPIRED
    Not answered before the expiry time.
    MISSED
    Another transfer company accepted the journey first.
  • replacementboolean

    True when the journey is offered again after another company dropped it.

Errors this endpoint can return

  • When: The offer is for another company.

    What to do: Check that the id belongs to your company and that you use the key of the right user. Ask Transferz to check the account's permissions if the id is correct.