{ "openapi": "3.0.1", "info": { "title": "Shipping Rate Comparison (USPS, UPS, FedEx)", "description": "Compare Shipping Costs Across All Major Carriers\nShipping costs vary wildly between carriers. The same package can cost $8 with USPS or $25 with FedEx — but most people don't have time to check all three.\n\nThe Shipping Rate Comparison actor queries USPS, UPS, and FedEx APIs simultaneously", "version": "1.0", "x-build-id": "52OnmOlihDL2dN2TN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~shipping-rate-comparison-usps-ups-fedex/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-shipping-rate-comparison-usps-ups-fedex", "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/alizarin_refrigerator-owner~shipping-rate-comparison-usps-ups-fedex/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-shipping-rate-comparison-usps-ups-fedex", "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/alizarin_refrigerator-owner~shipping-rate-comparison-usps-ups-fedex/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-shipping-rate-comparison-usps-ups-fedex", "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": [ "originZip", "destinationZip", "weight" ], "properties": { "originZip": { "title": "Origin ZIP Code", "type": "string", "description": "Sender's ZIP code (US only)" }, "destinationZip": { "title": "Destination ZIP Code", "type": "string", "description": "Recipient's ZIP code (US only)" }, "weight": { "title": "Package Weight", "minimum": 0.1, "maximum": 150, "type": "number", "description": "Weight of the package", "default": 2 }, "weightUnit": { "title": "Weight Unit", "enum": [ "lb", "oz", "kg" ], "type": "string", "description": "Unit for the package weight", "default": "lb" }, "length": { "title": "Package Length", "minimum": 1, "maximum": 108, "type": "number", "description": "Length of the package in inches", "default": 10 }, "width": { "title": "Package Width", "minimum": 1, "maximum": 108, "type": "number", "description": "Width of the package in inches", "default": 8 }, "height": { "title": "Package Height", "minimum": 1, "maximum": 108, "type": "number", "description": "Height of the package in inches", "default": 6 }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample rates without API credentials. Perfect for testing.", "default": false }, "carriers": { "title": "Carriers to Compare", "type": "array", "description": "Select which carriers to get rates from", "items": { "type": "string", "enum": [ "USPS", "UPS", "FedEx" ] }, "default": [ "USPS", "UPS", "FedEx" ] }, "uspsUserId": { "title": "USPS Web Tools User ID", "type": "string", "description": "Your USPS Web Tools API User ID (free at usps.com/business/web-tools-apis)" }, "upsClientId": { "title": "UPS Client ID", "type": "string", "description": "Your UPS API Client ID from developer.ups.com" }, "upsClientSecret": { "title": "UPS Client Secret", "type": "string", "description": "Your UPS API Client Secret" }, "fedexApiKey": { "title": "FedEx API Key", "type": "string", "description": "Your FedEx Developer API Key from developer.fedex.com" }, "fedexSecretKey": { "title": "FedEx Secret Key", "type": "string", "description": "Your FedEx Developer Secret Key" }, "fedexAccountNumber": { "title": "FedEx Account Number", "type": "string", "description": "Your FedEx Account Number (for negotiated rates)" } } }, "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 } } } } } } } } } }