Create an order export job

post

https://v3.api.hypertrack.com/orders/export

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.

Body Params

email_recipients

array of strings

required

List of email addresses to send the export download link

email_recipients*

completed_at_from

string | null

Defaults to null

Filter orders completed after this timestamp (ISO 8601)

completed_at_to

string | null

Defaults to null

Filter orders completed before this timestamp (ISO 8601)

created_at_from

string | null

Defaults to null

Filter orders created after this timestamp (ISO 8601)

created_at_to

string | null

Defaults to null

Filter orders created before this timestamp (ISO 8601)

scheduled_at_from

string | null

Defaults to null

Filter orders scheduled after this timestamp (ISO 8601)

scheduled_at_to

string | null

Defaults to null

Filter orders scheduled before this timestamp (ISO 8601)

planned_at_from

string | null

Defaults to null

Filter orders planned after this timestamp (ISO 8601)

planned_at_to

string | null

Defaults to null

Filter orders planned before this timestamp (ISO 8601)

status

string | null

Defaults to null

Filter by order status (comma-separated)

worker_handle

string | null

Defaults to null

Filter by worker handle

device_id

string | null

Defaults to null

Filter by device ID

order_metadata_filter

string | null

Defaults to null

Filter by order metadata (JSON string)

region_filter

string | null

Defaults to null

Filter by region (JSON string)

ops_group_handle

string | null

Defaults to null

Filter by ops group handle

search_term

string | null

Defaults to null

Search term for orders

tracking_status

string | null

Defaults to null

Filter by tracking status

plan_mode

string | null

Defaults to null

Filter by plan mode

track_mode

string | null

Defaults to null

Filter by track mode

worker_profile_filter

string | null

Defaults to null

Filter by worker profile (JSON string)

filter_outage_category

string | null

Defaults to null

Filter by outage category

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response

401Authentication error

422Validation error