{ "openapi": "3.0.1", "info": { "title": "US Import Shipment Monitor (Bill of Lading) — No Login", "description": "Watch importers, suppliers or HS codes and get only NEW US customs bills of lading since the last run: shipper, consignee, product, HS code, containers, weight, arrival date. Data current to within days. Daily schedule. No login. MCP-ready. $20 per 1,000 alerts.", "version": "1.0", "x-build-id": "Usbn7TSyyKEL4Tavs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/flamboyant_liner~shipment-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-flamboyant_liner-shipment-monitor", "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/flamboyant_liner~shipment-monitor/runs": { "post": { "operationId": "runs-sync-flamboyant_liner-shipment-monitor", "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/flamboyant_liner~shipment-monitor/run-sync": { "post": { "operationId": "run-sync-flamboyant_liner-shipment-monitor", "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": { "watchConsignees": { "title": "Watch importers (consignees)", "type": "array", "description": "US importers to watch for new inbound shipments. Give a company name (\"Home Depot\"), an ImportYeti slug (\"home-depot-usa\") or a full importyeti.com/company/... URL. Names are resolved to the importer with the most shipments and the match is cached per monitor ID.", "default": [ "Walmart", "Home Depot" ], "items": { "type": "string" } }, "watchShippers": { "title": "Watch overseas suppliers (shippers)", "type": "array", "description": "Foreign suppliers to watch, e.g. \"Foxconn Technology\", a slug (\"foxconn-technology\") or an importyeti.com/supplier/... URL. Each new shipment shows which US company received it.", "default": [], "items": { "type": "string" } }, "watchHsCodes": { "title": "Watch HS codes (products)", "type": "array", "description": "Harmonized System codes to watch for new shipments of a product category, 2 to 6 digits, e.g. 8507 (batteries), 0804.30 (pineapples), 9403 (furniture). Rows from HS watches carry the shipper but no consignee (the source hides it on product pages).", "default": [], "items": { "type": "string" } }, "productKeywords": { "title": "Product keywords", "type": "array", "description": "Case-insensitive words matched against the cargo description of every shipment found by the watches above. A shipment is emitted only if it contains at least one keyword. Empty = no filter.", "default": [], "items": { "type": "string" } }, "lookbackDays": { "title": "Lookback window (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only consider shipments that arrived within this many days. US customs data is published with a lag of about one week, so keep this at 14 or more; the seen-state prevents duplicates across runs.", "default": 30 }, "maxNewPerWatch": { "title": "Max new shipments per watch", "minimum": 1, "maximum": 50, "type": "integer", "description": "Stop after emitting this many new shipments for each watched company, supplier or HS code. Shipments beyond the cap stay unseen and are emitted on the next run.", "default": 5 }, "maxItems": { "title": "Max shipments per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Overall cap on shipments emitted in one run.", "default": 10 }, "firstRunMode": { "title": "First run mode", "enum": [ "emitAll", "baseline" ], "type": "string", "description": "What to do when the monitor has no saved state yet. emitAll: treat every current shipment in the lookback window as new and emit it (good for a one-off pull or a first test). baseline: silently record every current shipment as seen and emit nothing, so the next scheduled run reports only what arrived since.", "default": "emitAll" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. After each run a JSON summary {monitorId, runAt, newCount, watches[], shipments[first 50]} is POSTed here (Slack/Zapier/Make/your API).", "default": "" }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of this watchlist. Each monitor ID keeps its own seen-state in a key-value store named shipment-monitor-, so you can run several profiles (e.g. \"competitor-suppliers\", \"battery-imports\") side by side.", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The source hides shipment data after 25 company/supplier pageviews per IP address, so keep Apify residential proxy on (a fresh IP is used for every page). HS-code pages are not limited.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }