Skip to content

Get available offers

GET/offers/available/all

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

Retrieves all available offers for the provided credentials

Lists the offers your company can still accept or decline. Use it to catch up when you missed offer webhooks, or poll it if you do not receive webhooks. Only offers for your own companies are returned; an empty list means nothing is open.

Guides: Accept or decline offers, How a journey reaches you

Headers

  • X-Request-IDstring

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

Responses

OK

An array; each item has these attributes.

  • 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.