Flipdish · Schema

JobResponse

Job Response

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Id integer Id
CreatedAt string Created At
Status string Status
PackageType string Package Type
TransportType string Transport Type
AssignmentCode string Assignment Code
PickupAt string Pickup At
DropoffAt string Dropoff At
Comment string Comment
Distance number Distance
Duration integer Duration
Deliveries array Deliveries
Pricing object
Driver object
View JSON Schema on GitHub

JSON Schema

platform-job-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-job-response-schema.json",
  "title": "JobResponse",
  "description": "Job Response",
  "type": "object",
  "properties": {
    "Id": {
      "format": "int32",
      "description": "Id",
      "type": "integer",
      "example": 500123
    },
    "CreatedAt": {
      "format": "date-time",
      "description": "Created At",
      "type": "string",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "Status": {
      "description": "Status",
      "type": "string",
      "example": "Active"
    },
    "PackageType": {
      "description": "Package Type",
      "type": "string",
      "example": "string"
    },
    "TransportType": {
      "description": "Transport Type",
      "type": "string",
      "example": "string"
    },
    "AssignmentCode": {
      "description": "Assignment Code",
      "type": "string",
      "example": "string"
    },
    "PickupAt": {
      "description": "Pickup At",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "DropoffAt": {
      "description": "Dropoff At",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "Comment": {
      "description": "Comment",
      "type": "string",
      "example": "string"
    },
    "Distance": {
      "format": "double",
      "description": "Distance",
      "type": "number",
      "nullable": true,
      "example": 1.0
    },
    "Duration": {
      "format": "int32",
      "description": "Duration",
      "type": "integer",
      "nullable": true,
      "example": 1
    },
    "Deliveries": {
      "description": "Deliveries",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobDelivery"
      },
      "example": []
    },
    "Pricing": {
      "$ref": "#/components/schemas/JobPricing"
    },
    "Driver": {
      "$ref": "#/components/schemas/JobDriver"
    }
  }
}