Skip to main content

offer

accepted_atstring,null<date-time>nullable

Timestamnp when the offer ahs been accepted

bookingstring | nullnullable

URI-reference to the bookings related to the offer

dropoff_nodestring

URI reference of the drop off node for the offer

dropoff_node_assignment_orderinteger

Order of the drop off node

dropoff_node_scheduled_tsstring<date-time>

Drop off node scheulde ts

new_assignmentstring<uri-reference>

Assingmnet URI for the offer

offer_message_generation_failed_atstring,null<date-time>nullable

If offer couldn't be generate, timestamp of the event

offer_message_generation_okboolean

True, if offer has been generated

offer_typestring

Type of the offer. For production offers, this will be set to real

old_assignmentstring,null<uri-reference>nullable

Previous assignment for the offer

pickup_nodestring<uri-reference>

Pickup node URI for the offer

pickup_node_assignment_orderinteger

Pickup node assignment order

pickup_node_scheduled_tsstring<date-time>

Scheduled timestamp for the pickup node of the offer

point_nodestring,null<uri-reference>nullable

If offer includes point, URI of the point

point_node_assignment_orderinteger

POint assingmnet order

point_node_scheduled_tsstring,null<date-time>nullable

Scheduled timestamp of th epoint for the offer if any

projectstring,null<uri-reference>nullable

Project this offer belongs to

ready_to_be_sent_to_customerboolean

Flag indicating if the offer is valid and can be used by the customer

scheduled_to_send_atstring,null<date-time>nullable

Timestamp when the offer is scheduled to be sent to the customer

sent_to_customerboolean

Flag indicating if the offer has been sent to the customer

should_be_auto_acceptedboolean | nullnullable

Flag indicating if the offer wil be autoaccepted by the customer

simulationstring,null<uri-reference>nullable

Simulation the offer belongs to

statusstring

Status of the offer:

  • accepted
  • declined

Possible values: [accepted, new, sent, rejected, inactive, payment_failed, fail_to_board, rejected_by_timeout]

user_accepted_atstring,null<date-time>nullable

Timestamp of user accepting the offer

vehiclestring<uri-reference>

Vehicle the offer has been generated for

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf
integer

Can be integer

modified_atstring<date-time>

Last modification timestampo of the object

resource_uristring<uri-reference>

URI of the object instance

offer
{
  "accepted_at": "2024-07-29T15:51:28.071Z",
  "booking": "string",
  "dropoff_node": "string",
  "dropoff_node_assignment_order": 0,
  "dropoff_node_scheduled_ts": "2024-07-29T15:51:28.071Z",
  "new_assignment": "string",
  "offer_message_generation_failed_at": "2024-07-29T15:51:28.071Z",
  "offer_message_generation_ok": true,
  "offer_type": "string",
  "old_assignment": "string",
  "pickup_node": "string",
  "pickup_node_assignment_order": 0,
  "pickup_node_scheduled_ts": "2024-07-29T15:51:28.071Z",
  "point_node": "string",
  "point_node_assignment_order": 0,
  "point_node_scheduled_ts": "2024-07-29T15:51:28.071Z",
  "project": "string",
  "ready_to_be_sent_to_customer": true,
  "scheduled_to_send_at": "2024-07-29T15:51:28.071Z",
  "sent_to_customer": true,
  "should_be_auto_accepted": true,
  "simulation": "string",
  "status": "accepted",
  "user_accepted_at": "2024-07-29T15:51:28.071Z",
  "vehicle": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "id": 0,
  "modified_at": "2024-07-29T15:51:28.071Z",
  "resource_uri": "string"
}
Last updated on