{ "openapi": "3.0.1", "info": { "title": "DHL Package Tracking Scraper", "description": "Track DHL packages and export current status, delivery estimates, routes, checkpoints, and service details as structured records.", "version": "1.0", "x-build-id": "g5JVE1Yg8ehPVED5c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~dhl-package-tracking-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-dhl-package-tracking-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/muhammadafzal~dhl-package-tracking-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-dhl-package-tracking-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/muhammadafzal~dhl-package-tracking-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-dhl-package-tracking-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "trackingNumbers", "demoMode", "accessMode", "language", "requesterCountryCode", "includeRaw" ], "properties": { "trackingNumbers": { "title": "Tracking numbers", "minItems": 1, "maxItems": 10, "type": "array", "description": "Use this to track 1–10 DHL shipment IDs. Enter one ID per row, for example 7777777770. Separators and surrounding spaces are removed; IDs shorter than 5 characters are rejected.", "default": [ "7777777770" ], "items": { "type": "string" } }, "demoMode": { "title": "Use DHL demo response", "type": "boolean", "description": "Use this only with DHL's documented sample ID 7777777770 to return DHL's mocked API response without credentials. Turn it off for real packages.", "default": true }, "accessMode": { "title": "Access mode", "enum": [ "auto", "api", "website" ], "type": "string", "description": "Use auto to prefer the official API when a key is supplied and otherwise use DHL's public tracking page. API requires a DHL key; website uses a browser and can be challenged.", "default": "auto" }, "dhlApiKey": { "title": "DHL API key", "type": "string", "description": "Use this for reliable real-package tracking through DHL Shipment Tracking - Unified. Paste the Consumer Key from developer.dhl.com; it is never written to output or logs." }, "recipientPostalCode": { "title": "Recipient postal code", "type": "string", "description": "Use this when DHL requires destination verification or when you need protected destination details. Supply one postal code that applies to the single requested shipment.", "default": "" }, "language": { "title": "Response language", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Use this for localized DHL status descriptions. Enter a two-letter ISO 639-1 code such as en or de; the default is en.", "default": "en" }, "requesterCountryCode": { "title": "Requester country", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Use this to localize public tracking behavior. Enter a two-letter ISO 3166-1 code such as US or DE; the default is US.", "default": "US" }, "includeRaw": { "title": "Include raw DHL response", "type": "boolean", "description": "Use this for debugging or fields not yet normalized. It can significantly enlarge each result; the default false keeps output compact.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use this for website mode when DHL challenges direct cloud traffic. Apify Proxy is enabled by default; API and demo modes do not need it.", "default": { "useApifyProxy": true } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }