{
  "openapi": "3.0.1",
  "info": {
    "title": "17TRACK Package Tracking Scraper | 3,000+ Carriers, Bulk",
    "description": "Track parcels from 3,000+ carriers via 17TRACK in bulk: status, carrier, origin and destination, latest event, ETA, delivery date and the full checkpoint history. Thousands of numbers per run, change monitoring and webhooks.",
    "version": "1.0",
    "x-build-id": "CFKpE7C9bjTgv0dhT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/trev0n~17track-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-trev0n-17track-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/trev0n~17track-scraper/runs": {
      "post": {
        "operationId": "runs-sync-trev0n-17track-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/trev0n~17track-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-trev0n-17track-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",
        "properties": {
          "trackingNumbers": {
            "title": "Tracking numbers",
            "type": "array",
            "description": "Parcel tracking numbers, one per line. Any carrier: postal services (China Post, USPS, Royal Mail, Poczta Polska, ...), couriers (DHL, UPS, FedEx, DPD, GLS, ...) and e-commerce lines (Cainiao, YunExpress, 4PX, ...). The carrier is detected automatically. 17TRACK result links work too.",
            "default": [
              "1Z999AA10123456784"
            ],
            "items": {
              "type": "string"
            }
          },
          "carrier": {
            "title": "Carrier",
            "enum": [
              "0",
              "100001",
              "7041",
              "100002",
              "100003",
              "21051",
              "11031",
              "100005",
              "100018",
              "100331",
              "16081",
              "14041",
              "9071",
              "3041",
              "1151",
              "10021",
              "3011",
              "3013",
              "190271",
              "190008",
              "190094",
              "190012",
              "100012",
              "100006",
              "100004"
            ],
            "type": "string",
            "description": "Leave on \"Detect automatically\" for mixed lists. Pick a carrier when 17TRACK cannot recognise your numbers (status CarrierNotDetected): every number in this run is then looked up with that carrier.",
            "default": "0"
          },
          "includeEvents": {
            "title": "Full checkpoint history",
            "type": "boolean",
            "description": "Add every tracking event (time, location, description, carrier) to each package. Turn off if you only need the current status.",
            "default": true
          },
          "onlyFound": {
            "title": "Only packages with tracking data",
            "type": "boolean",
            "description": "Leave out numbers 17TRACK has no information about yet. Those rows are free either way.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "Drop empty fields",
            "type": "boolean",
            "description": "Remove fields without a value from each row for a leaner export.",
            "default": false
          },
          "monitorChanges": {
            "title": "Monitor changes",
            "type": "boolean",
            "description": "Remember earlier runs and return only packages that are new or have news: a new status (for example In transit → Out for delivery → Delivered) or a new tracking event. Each row says whether the status changed and what it was before. Schedule the same list every few hours.",
            "default": false
          },
          "stateKey": {
            "title": "Monitoring list name",
            "type": "string",
            "description": "Optional name for the remembered list, so several schedules keep separate histories. Leave empty to derive it from the numbers."
          },
          "emitUnchanged": {
            "title": "Also return unchanged packages",
            "type": "boolean",
            "description": "In monitoring mode, return every package, not only new or changed ones.",
            "default": false
          },
          "webhookUrl": {
            "title": "Webhook for changes",
            "type": "string",
            "description": "Optional URL that receives a POST with the new and changed packages after each run (Zapier, Make, n8n, your shop or CRM)."
          },
          "maxConcurrency": {
            "title": "Parallel browsers",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many batches of 40 numbers are tracked at the same time. 2 handles thousands of numbers per run.",
            "default": 2
          },
          "startUrls": {
            "title": "17TRACK links (list editor)",
            "type": "array",
            "description": "Alternative to \"Tracking numbers\" for integrations that send URLs, e.g. https://t.17track.net/en#nums=RR123456785CN. Both lists are combined.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy keeps tracking reliable on large lists. Switch to residential proxies if many batches report a verification check.",
            "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}