Cancel Order (Task)

post https://developer-api.bringg.com/services/kmae04kd//

Use to cancel an active order (task).

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false - this order was not automatically assigned
  • true - this order was automatically assigned.

cancel_reason

Object

A object containing detailed information about the cancel reason, see Cancel Reasons Object.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A object containing detailed information about the customer associated with this order, Customer Object.

customer_id

Int32

The Id of the customer associated with this order.

delivery_price

double

The price of this delivery.

discount

double

The discount amount of this order.

dispatcher_id

Int32

If the dispatcher locked this order, the Id of the dispatcher.

distance_traveled

double

The actual distance traveled (in km).

ended_time

datetime

The date and time this order was ended. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

extras

Object

Internal Use.

external_id

string

The order's external Id.

fleet_delivery_external_id

string

If this order is assigned to an external fleet, this is the Id used by that external fleet.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

group_leader_id

Int32

If this order is a group of orders, this is the Id of the order representing the entire collection of orders in the group (the parent order containing all child orders in the group). This is the Id that Bringg operators (for example, dispatchers and users/drivers) view. NOTE: Bringg internally maintains each order and each order contains the same group leader Id.

group_uuid

uuid

If this order is a group of orders, this is the UUID of the group (see group_leader_id above).

last_assigned_time

datetime

The last date and time an order was assigned to the user (driver). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

left_to_be_paid

double

The unpaid balance of this total order.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

parent_task_id

Int32

If this order was created from another order (for example, a failed order), this is the Id of that original order.

payment_type_name

string

The name of the payment type. For example, Visa, Mastercard, or Amex.

pre_delivery_tip

double

The tip (gratuity) paid to the user (driver) before this order delivery.

post_delivery_tip_cash

double

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

post_delivery_tip_credit

double

The tip (gratuity) paid to the user (driver) by credit after this order delivery.

price_before_tax

double

The net price of this order not including taxes.

priority

Int32

The priority of this order.

reason

string

The reason the order was cancelled.

reason_id

Int32

The cancel reason ID.

reserved_until

datetime

The time an availability slot is no longer reserved for a specific consumer.

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

start_lat

double

The geoposition latitude of the user (driver) when this order started.

start_lng

double

The geoposition longitude of the user (driver) when this order started.

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 7 - cancelled
  • 8 - rejected
  • 9 - unacknowledged

This Order Created callback returns the value 7 (cancelled).

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order inventory.

task_notes

array of objects

An array of objects containing notes added to this order.

tax_price

double

The gross price of this order including taxes.

tip

double

The tip (gratuity) paid to the user (driver) by the customer for this order.

tip_driver_enabled

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped

title

string

This order's title. The maximum length is 255 characters.

total_price

double

The total price of this order.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver).

uuid

Int32

The universal unique Id of thise order.

webhooks

boolean

Indicates whether webhooks can be set for this order. The values are:

  • false or 0 - webhooks cannot be set for this task
  • true or 1 - webhooks can be set for this task.
Language