Bringg · Schema

Bringg Order (Task)

Represents an order (task) in Bringg with one or more waypoints, optional inventory, service plan, customer, run (route) assignment, and operational metadata.

Last-Mile DeliveryDelivery OrchestrationFulfillmentLogisticsRetailDispatchRoutingDriver AppCarrier NetworkFleet ManagementSupply ChainE-commerceSame-Day DeliveryCurbside PickupReturns

Properties

Name Type Description
id integer Bringg-assigned order id.
external_id string Caller-supplied external identifier.
title string
status integer Numeric task status (see Order Status reference).
merchant_id integer
team_ids array
scheduled_at string
no_later_than string
ready_to_execute boolean
active_way_point_id integer
customer object
way_points array
task_inventories array
service_plan_id integer
run_id integer
driver_id integer
vehicle_id integer
cancel_reasons object
created_at string
updated_at string
View JSON Schema on GitHub

JSON Schema

bringg-order-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/bringg/json-schema/bringg-order-schema.json",
  "title": "Bringg Order (Task)",
  "description": "Represents an order (task) in Bringg with one or more waypoints, optional inventory, service plan, customer, run (route) assignment, and operational metadata.",
  "type": "object",
  "properties": {
    "id": {"type": "integer", "description": "Bringg-assigned order id."},
    "external_id": {"type": "string", "description": "Caller-supplied external identifier."},
    "title": {"type": "string"},
    "status": {"type": "integer", "description": "Numeric task status (see Order Status reference)."},
    "merchant_id": {"type": "integer"},
    "team_ids": {"type": "array", "items": {"type": "integer"}},
    "scheduled_at": {"type": "string", "format": "date-time"},
    "no_later_than": {"type": "string", "format": "date-time"},
    "ready_to_execute": {"type": "boolean"},
    "active_way_point_id": {"type": "integer"},
    "customer": {"$ref": "bringg-customer-schema.json"},
    "way_points": {"type": "array", "items": {"$ref": "bringg-waypoint-schema.json"}},
    "task_inventories": {"type": "array", "items": {"type": "object"}},
    "service_plan_id": {"type": "integer"},
    "run_id": {"type": "integer"},
    "driver_id": {"type": "integer"},
    "vehicle_id": {"type": "integer"},
    "cancel_reasons": {"type": "object"},
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "required": ["id"]
}