{ "openapi": "3.0.1", "info": { "title": "Shopify Automation Toolkit", "description": "Automate Shopify operations: export products/orders, backup store data, sync inventory, generate sales reports. 9 powerful tasks, no coding required.", "version": "1.0", "x-build-id": "5NkhzdgDJaGD79kjg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/waxlike_polecat~shopify-automation-toolkit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-waxlike_polecat-shopify-automation-toolkit", "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/waxlike_polecat~shopify-automation-toolkit/runs": { "post": { "operationId": "runs-sync-waxlike_polecat-shopify-automation-toolkit", "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/waxlike_polecat~shopify-automation-toolkit/run-sync": { "post": { "operationId": "run-sync-waxlike_polecat-shopify-automation-toolkit", "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": [ "task", "shopifyStore", "shopifyAccessToken" ], "properties": { "task": { "title": "Task to Execute", "enum": [ "export_products", "export_orders", "backup_store", "sync_inventory", "export_customers", "export_abandoned_carts", "sales_reports", "bulk_update_products", "store_analytics" ], "type": "string", "description": "Choose the automation task you want to perform on your Shopify store", "default": "export_products" }, "shopifyStore": { "title": "Shopify Store URL", "type": "string", "description": "Your Shopify store URL (e.g., your-store.myshopify.com)" }, "shopifyAccessToken": { "title": "Shopify Admin API Access Token", "type": "string", "description": "Your Shopify Admin API access token with necessary permissions" }, "format": { "title": "Export Format", "enum": [ "csv", "json" ], "type": "string", "description": "Choose the output format for exported data (applies to export tasks)", "default": "json" }, "dateRange": { "title": "Date Range Filter", "type": "object", "description": "Filter data by date range (optional, applies to orders and reports)" }, "orderStatus": { "title": "Order Status Filter", "enum": [ "all", "open", "closed", "cancelled", "fulfilled", "unfulfilled" ], "type": "string", "description": "Filter orders by status (for export_orders task)", "default": "all" }, "limit": { "title": "Record Limit", "minimum": 0, "type": "integer", "description": "Maximum number of records to process (0 = no limit)", "default": 0 }, "bulkUpdateData": { "title": "Bulk Update Configuration", "type": "object", "description": "Configuration for bulk product updates (for bulk_update_products task)" }, "inventorySyncConfig": { "title": "Inventory Sync Configuration", "type": "object", "description": "Configure inventory synchronization (for sync_inventory task)" }, "outputDestination": { "title": "Output Destination", "enum": [ "dataset", "key-value-store" ], "type": "string", "description": "Where to save the exported data", "default": "dataset" }, "dryRun": { "title": "Dry Run Mode", "type": "boolean", "description": "Enable dry run mode to preview changes without applying them (for update/sync tasks)", "default": false }, "includeMetafields": { "title": "Include Metafields", "type": "boolean", "description": "Include product/customer metafields in exports", "default": false }, "customFields": { "title": "Custom Fields to Export", "type": "array", "description": "Specify custom fields to include in exports (optional)", "items": { "type": "string" } } } }, "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 } } } } } } } } } }