Create an order export job

Creates an asynchronous job to export orders to CSV.gz file. Returns a job_id that can be used to check status. Download link will be sent via email when ready.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

worker_handle?|

Unique customer provided identifier of the worker to used retrieve orders associated with the specified worker

place_handle?|

Unique customer provided identifier of the place to be used retrieve orders associated with the specified place

search_term?|

String representing the search term. Search will be done on order_handle, ops_group_handle, worker_handle and metadata fields.

ops_group_handle?|

Unique Handle of Ops Group to fetch orders for

order_metadata_filter?|

JSON encoded string for order metadata to filter orders by

risk_status?|

Filter for risk status of order

region_filter?|

JSON object containing city, state, or country used to filter orders

status?|

String representation of Order status to fetch orders for. It can be comma separated list, each item in list can be one of completed, cancelled, rescheduled, disabled, ongoing, unplanned, assigned, planned. eg. ?status=completed,cancelled or ?status=completed to filter for one status

device_id?|

Filter for orders associated with this device id.

destination_geohash?|

Geohash of the area where order destination must lie.

plan_mode?unknown

Mode of planning to be used to filter orders

plan_id?|

Filter for orders in this plan id.

route_handle?|

Unique Handle of the route to fetch orders for

track_mode?unknown

Tracking mode to filter orders by. See pre_shift, on_shift documentation. full_shift includes both pre-shift and on-shift tracking. Note that on_time and flex are deprecated modes.

device_switch_mode?unknown

Device switch mode to filter orders by.

created_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date.

created_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that created within a timeframe.

created_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that created within a timeframe.

planned_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are planned on a given date.

planned_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.

planned_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.

scheduled_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date.

scheduled_at_date_without_tz?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date irrespective of timezone.

completed_at_date_without_tz?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date irrespective of timezone.

scheduled_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders which have scheduled_at within a timeframe.

scheduled_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that which have scheduled_at within a timeframe.

scheduled_at_without_tz_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day in all timezone.

scheduled_at_without_tz_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day in all timezone.

cancelled_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are cancelled on a given date.

cancelled_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that cancelled within a timeframe.

cancelled_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that cancelled within a timeframe.

completed_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date.

completed_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that completed within a timeframe.

completed_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that completed within a timeframe.

rescheduled_marked_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are rescheduled on a given date.

rescheduled_marked_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that rescheduled within a timeframe.

rescheduled_marked_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that rescheduled within a timeframe.

route_started_at_date?|

Date (YYYY-MM-DD) used as a filter to retrieve orders for which route started on a given date.

route_started_at_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders for which route started within a timeframe.

route_started_at_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders for which route started within a timeframe.

completed_at_without_tz_from?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day for all timezone for completed orders.

completed_at_without_tz_to?|

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day for all timezone for completed orders.

created_at_without_tz_from?|

Start Date (YYYY-MM-DD ) of the window to retrieve orders from that day for all timezone for created orders.

created_at_without_tz_to?|

End Date (YYYY-MM-DD ) of the window to retrieve orders till that day for all timezone for created orders.

created_at_date_without_tz?|

Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date irrespective of timezone.

driver_handle?|

Deprecated

Unique customer provided identifier of the driver to used retrieve orders associated with the specified driver

sort_direction?unknown

String indicating the preferred sorting type

fulfillment_attempt?|

Filter for fulfillment attempt number

aggregate?|

Flag to fetch order's aggregated data.

limit?|

Limit to number of results in response

pagination_token?|

Encoded value provided by our API to retrieve the next page of orders

send_outage?|

Boolean to send the outage in aggregation

tracking_status?|

Parameter to filter for tracked and untracked orders

filter_outage_category?|

List of outage category as comma separated strings used for filtering associated orders within time range

worker_profile_filter?|

JSON encoded string metadata associated with the worker to filter orders

worker_inside_destination?|

Boolean flag to filter orders based on whether the worker is inside the destination or not.

email_recipients?array<string>

Optional list of email addresses to send the export download link. Falls back to the account email when omitted.

Response Body

`application/json`

curl -X POST "https://example.com/orders/export" \  -H "Content-Type: application/json" \  -d '{}'

{  "job_id": "string",  "status": "string",  "message": "string"}

{  "title": "string",  "detail": "string"}

{  "code": "string",  "title": "string",  "detail": "string"}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`