API Reference

Bulk Job Operations

📘

These endpoints allow to perform operations on a list of jobs.

"Create jobs" POST request allows to submit a list of jobs to Radaro.

To create multiple jobs at once, provide the data in the next format:

  [
        {job_1_details},
        {job_2_details},
        ...
        {job_n_details}
  ]

"Get jobs" GET request allows to get a list of merchant jobs that were earlier created with this API key.

🚧

The use of capacity makes sense only when used in conjunction with route optimization feature

That means when optimizing list of jobs job and driver's car capacity are taken into account if corresponding ro option is enabled.

Attributes

  • deliver_after: 2020-02-06T09:00:00Z (string) - ISO-8601 date format
  • deliver_before: 2020-02-06T11:00:00Z (string) - ISO-8601 date format
  • deliver_address (Location - Required)
  • deliver_address_2: 2nd floor, apartment 12 (string).3
  • delivery_zone: 123 (number) - Delivery zone ID
  • customer (Customer, required)
  • pickup_after: 2020-02-06T05:00:00Z (string) - ISO-8601 date format
  • pickup_before: 2020-02-06T07:00:00Z (string) - ISO-8601 date format
  • pickup_address (Location - Required)
  • pickup_address_2: 2nd floor, apartment 12 (string)
  • pickup (Pickup)
  • comment: Order #3 (string) - Any string
  • title: PO1298371 - Any string
  • title_2: TD12345 - Any string
  • title_3: `` - Any string
  • manager (Manager)
  • starting_point (Location) - Point at which the driver began to perform job.
  • started_at: 2020-02-06T009:30:00Z (string) - ISO-8601 date format. Time when driver began to perform job.
  • updated_at: 2020-02-06T009:30:00Z (string) - ISO-8601 date format. Time when job changed status.
  • created_at: 2020-01-06T009:20:00Z (string) - ISO-8601 date format. Time when job was created.
  • pickup_geofence_entered_at: 2020-02-06T010:00:00Z (string) - ISO-8601 date format. Time when driver entered pickup geofence zone.
  • pickup_geofence_exited_at: 2020-02-06T011:00:00Z (string) - ISO-8601 date format. Time when driver came out of pickup geofence zone.
  • pick_up_confirmation_photos
    [ { "image": "https://radaro-api.s3.amazonaws.com/media/OrderPickupConfirmationPhoto/6d42b403-0e4.jpg" } ]
    • list of objects
  • pick_up_confirmation_signature: \path\to\pickup-confirmation\signature (string)
  • pick_up_confirmation_comment: `` - Comment left by driver when confirming order pickup.
  • rating: 10 (number) - Integer from 1 to 10. Estimate that the customer has given delivery.
  • customer_comment: Very good!! (string) - Comment that the customer has given delivery.
  • pending_comment: 2nd floor (string)
  • confirmation_signature: \path\to\confirmation\signature (string)
  • confirmation_comment: `` (string) - Comment that driver has given delivery.
  • geofence_entered_at: 2020-02-06T010:00:00Z (string) - ISO-8601 date format. Time when driver entered in geofence.
  • geofence_exited_at: 2020-02-06T011:00:00Z (string) - ISO-8601 date format. Time when driver came out of geofence.
  • duration: 00:10:00 (string) - Duration of job's delivery.
  • deadline_passed: false (boolean) - False if job's deadline passed, else - true.
  • external_id: 111111 (string) - External ID of job.
  • driver: 345322 (number) - Driver's member ID, null by default.
  • order_distance: 12333 (number) - Distance from starting point to deliver address in miles or kilometers (depends on merchant's settings).
  • status: in_progress (string, required) - Job's current status, not_assigned by default.
  • order_id: 123234 (number) - Order ID in system.
  • description: **Formatted job description**
  • sub_branding: 123 (number) - Sub-brand ID
  • label: 1 (number) - label ID
  • labels: 1, 2 (array[number]) - Array of labels ID
  • skill_sets: 1, 3 (array[number]) - Array of skill sets ID
  • error_code (ErrorCode) - error code for failed job.
  • error_comment: "Error comment" (string) - additional comment for failed job.
  • customer_tracking_url: "http://account.radaro.com.au/#/order/NTc0NQ/32fe9c08-105e-4128-b2a2-9cecb0859fb4"
  • order_confirmation_photos
    [ { "image": "https://radaro-api.s3.amazonaws.com/media/OrderConfirmationPhoto/6d42b403-0e2.jpg" } ]
    • list of objects
  • order_confirmation_documents
    [ { "id": 11, "document": "<http://127.0.0.1:8000/media/OrderConfirmationDocument/80eece96-fe14-4ec4-bde6-31d62cb9a003.pdf">, "name": "Job-ID-14312344_Custom-document_15-05-2020-16.3", "tags": [ { "id": 3, "name": "Proof of Delivery" }, { "id": 4, "name": "Invoices" } ] } ]
  • pre_inspection_comment: `` (string) - Comment that driver has given before delivery.,
  • pre_inspection_signature: \path\to\pre-inspection\signature (string),
  • pre_inspection_photos
    [ { "image": "https://radaro-api.s3.amazonaws.com/media/OrderPreConfirmationPhoto/6d42b403-0e2.jpg" } ]
    • list of objects
  • completion_code - Completion code for job: Codes indicating specific completing statuses or reasons
  • completion_comment: "Completion comment" (string)
  • driver_checklist : Checklist completion results
  • delivery_interval : Job delivery interval
  • barcodes (array[Barcode]) - list of job barcodes
  • cargoes (object)
    • skids (array[Skid])
    • line_level_data (array[LineLevelData])
  • capacity: 200 (number) - Job capacity value in local units of measurement. To use this attribute ensure your merchant has enable_job_capacity setting enabled.
  • enable_rating_reminder: true (boolean)
  • optimisation_id: 3456 (number)
  • custom_redirect_url: 'https://example.com/ (string),
  • concatenated_order
    { "order_id": 183362642, "external_id": "external-job-000" }
    • concatenated order ids

Parameters

  • api_key (string) - Merchant's API key