Attributes

Name	Type	Required	Description
`external_id`	string	❌ No	External ID of the job. Example: `"111111"`
`deliver_after`	string	❌ No	The earliest time the delivery should start (ISO-8601). Example: `"2020-02-06T09:00:00Z"`
`deliver_before`	string	❌ No	The latest time the delivery should be completed (ISO-8601). Example: `"2020-02-06T11:00:00Z"`
`delivery_interval`	DeliveryInterval	❌ No	Job delivery interval
`manager`	Manager	❌ No	Manager details
`customer`	Customer	✅ Yes	Customer details
`deliver_address`	Location	✅ Yes	Delivery location details
`deliver_address_2`	string	❌ No	Additional delivery details. Example: `"2nd floor, apartment 12"`
`confirmation_signature`	string	❌ No	Path to confirmation signature. Example: `"\path\to\confirmation\signature"`
`title`	string	❌ No	Job title. Example: `"PO1298371"`
`title_2`	string	❌ No	Additional title field. Example: `"TD12345"`
`title_3`	string	❌ No	Additional title field.
`comment`	string	❌ No	Any string. Example: `"Order #3"`
`started_at`	string	❌ No	Time when driver began to perform job (ISO-8601). Example: `"2020-02-06T09:30:00Z"`
`picked_up_at`	string	❌ No	Time when the order was picked up (ISO-8601). Example: `"2020-02-06T09:30:00Z"`
`status`	string	✅ Yes	Job's current status. Default: `"not_assigned"`. Example: `"in_progress"`
`order_id`	number	❌ No	Order ID in the system. Example: `123234`
`starting_point`	Location	❌ No	Point where the driver began to perform the job
`confirmation_comment`	string	❌ No	Comment provided by the driver at delivery
`updated_at`	string	❌ No	Time when job status changed (ISO-8601). Example: `"2020-02-06T09:30:00Z"`
`created_at`	string	❌ No	Time when job was created (ISO-8601). Example: `"2020-01-06T09:20:00Z"`
`rating`	number	❌ No	Rating from 1 to 10 given by the customer. Example: `10`
`customer_comment`	string	❌ No	Customer's feedback. Example: `"Very good!!"`
`pending_comment`	string	❌ No	Example: `"2nd floor"`
`customer_review_opt_in`	boolean	❌ No	Indicates whether the customer opted in for review. Default: `false`
`deadline_passed`	boolean	❌ No	`false` if job's deadline passed, else `true`
`driver`	number	❌ No	Driver's member ID, `null` by default. Example: `345322`
`merchant`	number	❌ No	Merchant ID. Example: `1`
`description`	string	❌ No	Job description. Example: `"Formatted job description"`
`error_code`	ErrorCode	❌ No	Error code for a failed job
`error_comment`	string	❌ No	Additional comment for failed job. Example: `"Error comment"`
`completion_code`	CompletionCode	❌ No	Completion code for the job: success or error
`completion_codes`	array[CompletionCode]	❌ No	List of completion codes for job success or failure
`completion_comment`	string	❌ No	Completion comment. Example: `"Completion comment"`
`customer_tracking_url`	string	❌ No	Example: `"<http://account.radaro.com.au/#/order/NTc0NQ/32fe9c08-105e-4128-b2a2-9cecb0859fb4>"`
`is_confirmed_by_customer`	boolean	❌ No	Indicates whether the customer confirmed the order. Default: `false`
`order_confirmation_photos`	array[object]	❌ No	List of confirmation photos with image URLs
`order_confirmation_documents`	array[object]	❌ No	List of confirmation documents including ID, name, and tags
`pre_inspection_comment`	string	❌ No	Driver's comment before delivery
`pre_inspection_signature`	string	❌ No	Path to pre-inspection signature
`pre_inspection_photos`	array[object]	❌ No	List of pre-inspection photos with image URLs
`driver_checklist`	DriverChecklist	❌ No	Checklist completion results
`pre_confirmation_photos`	array[object]	❌ No	List of pre-confirmation photos with image URLs
`pre_confirmation_signature`	string	❌ No	Path to pre-confirmation signature
`pre_confirmation_comment`	string	❌ No	Driver's comment before delivery
`skill_sets`	array[number]	❌ No	Array of skill set IDs. Example: `[1, 3]`
`barcodes`	array[Barcode]	❌ No	List of job barcodes
`wayback_point`	Location	❌ No	Location where the driver started the return trip
`wayback_hub`	Hub	❌ No	Hub where the driver started the return trip
`completed_at`	string	❌ No	Completion timestamp (ISO-8601). Example: `"2020-02-06T09:30:00Z"`
`pick_up_confirmation_photos`	array[object]	❌ No	List of pickup confirmation photos
`pick_up_confirmation_signature`	string	❌ No	Path to pickup confirmation signature
`pick_up_confirmation_comment`	string	❌ No	Comment left by the driver upon order pickup
`public_report_link`	string	❌ No	Public report link. Example: `"<https://example.com/>"`
`optimisation_id`	number	❌ No	Optimisation ID. Example: `3456`
`enable_rating_reminder`	boolean	❌ No	If `true`, sends a rating reminder
`custom_redirect_url`	string	❌ No	Custom redirect URL. Example: `"<https://example.com/>"`
`orders`	array[object]	❌ No	List of order objects containing `order_id` and `external_id`
`capacity`	number	❌ No	Job capacity value in local units of measurement. To use this attribute ensure your merchant has enable_job_capacity setting enabled.
`capacity_2`	number	❌ No	Job capacity value in local units of measurement. To use this attribute ensure your merchant has enable_job_capacity setting enabled and Capacity 2 field set.
`capacity_3`	number	❌ No	Job capacity value in local units of measurement. To use this attribute ensure your merchant has enable_job_capacity setting enabled and Capacity 3 field set.
`service_time_sec`	number	❌ No	Example: `5`

Parameters

Name	Type	Required	Description
`api_key`	string	✅ Yes	Merchant's API key. Example: `"123"`