Skip to content

Request report

Request a report

import requests

url = "https://apipl.zenovate.org/v1/exports"

payload = {
    "type": "ORDER_ITEMS",
    "name": "demo-export",
    "query": {
        "filter": [
            {
                "id": "order.orderValue",
                "operator": "iLike",
                "value": "MA"
            }
        ],
        "joinOperator": "AND",
        "columns": ["order.orderNumber", "order.orderValue", "product.amazonSku", "unitCost", "currency"]
    }
}
headers = {
    "accept": "*/*",
    "content-type": "application/json",
    "x-api-key": "Bearer replace_api_key_here",
    "x-org-id": "replace_org_id_here"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

You will receive a response with the following structure:

{
  "message": "Enqueue export job successfully",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "demo-export",
    "type": "ORDER_ITEMS",
    "status": "PENDING",
    "user": {
      "email": "ryzan.b@zendom.co.uk"
    },
    "createdAt": "2026-08-10T08:21:54.122Z"
  }
}

Check status

The id in the response is the unique identifier for the export job. You can use this id to check the status of the export job:

import requests

url = "https://apipl.zenovate.org/v1/exports/3fa85f64-5717-4562-b3fc-2c963f66afa6"

headers = {
    "accept": "*/*",
    "x-api-key": "Bearer replace_api_key_here",
    "x-org-id": "replace_org_id_here"
}

response = requests.get(url, headers=headers)

print(response.text)

You will receive a response with the following structure:

{
  "message": "Fetch export job successfully",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "demo-export",
    "type": "ORDER_ITEMS",
    "status": "PENDING",
    "user": {
      "email": "ryzan.b@zendom.co.uk"
    },
    "createdAt": "2026-08-10T08:21:54.122Z"
  }
}

Download the report

Once the export job status is COMPLETED, you can download the report using the following code:

import requests

url = "https://apipl.zenovate.org/v1/exports/3fa85f64-5717-4562-b3fc-2c963f66afa6/download"

headers = {
    "accept": "*/*",
    "x-api-key": "Bearer replace_api_key_here",
    "x-org-id": "replace_org_id_here"
}

response = requests.get(url, headers=headers)

print(response.text)

You will receive a response with the following structure:

{
  "message": "Generate export file URL successfully",
  "data": {
    "url": "https://s3.zenovate.org/uploads/exports/ORDER_ITEMS/4bf097f1-3511-4d37-8e46-024d4d7a4ffb/file-short.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20260810%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260810T083859Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0365037a9ae1eee8edf5767ead000a95da20d0aa7745246158fe6d836393be23"
  }
}

The url in the response is the download link for the report. You can use this URL to download the report file.