{ "openapi": "3.0.1", "info": { "title": "Restock Margin Guard", "description": "Review your own SKU reorder quantity and verified landed gross margin against the required target. Explicit missing costs, MOQ, pack rounding and manual approval.", "version": "1.0", "x-build-id": "QiPgzAeZc1kBGtZsO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/afkdigital~restock-margin-guard/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-afkdigital-restock-margin-guard", "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/afkdigital~restock-margin-guard/runs": { "post": { "operationId": "runs-sync-afkdigital-restock-margin-guard", "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/afkdigital~restock-margin-guard/run-sync": { "post": { "operationId": "run-sync-afkdigital-restock-margin-guard", "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": [ "requestedQuantity", "targetMarginPct", "targetCurrency" ], "properties": { "products": { "title": "Own SKU / retail price records (JSON)", "maxItems": 1000, "type": "array", "description": "Fields: sku, salePrice (excludes sales tax), currency, saleUnit, optional targetMarginPct. Do not include buyer contact data.", "items": { "type": "object" } }, "productsCsv": { "title": "Own SKU CSV text", "maxLength": 1500000, "type": "string", "description": "Alternative to products array. Header: sku,salePrice,currency,saleUnit,targetMarginPct." }, "productsFile": { "title": "Own SKU CSV/JSON upload (Apify storage only)", "type": "string", "description": "Alternative to products / productsCsv. The uploaded file must be a readable Apify Key-Value Store record; third-party URLs are rejected." }, "quotes": { "title": "Supplier quotes (JSON)", "maxItems": 1000, "type": "array", "description": "Each: quoteId,sku,supplier,currency,purchaseUnit,moq,packSize,tiers[{minQty,unitPrice}],validUntil,costs{freightTotal,nonRecoverableTaxTotal or nonRecoverableTaxRatePct,otherLandedTotal,salesCommissionPct}. If units differ, state unitsPerPurchaseUnit.", "items": { "type": "object" } }, "quotesCsv": { "title": "Supplier quotes CSV text", "maxLength": 1500000, "type": "string", "description": "Alternative to quotes array. Columns include unitPrice for a single all-units tier or tiersJson for multiple tiers, plus flat fee columns." }, "quotesFile": { "title": "Supplier quote CSV/JSON upload (Apify storage only)", "type": "string", "description": "Alternative to quotes / quotesCsv. Sensitive uploaded files are read only within Apify storage; no arbitrary download URLs." }, "requestedQuantity": { "title": "Desired sellable units", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Required SKU sales-unit quantity; procurement order is rounded up to MOQ and pack multiple.", "default": 20 }, "targetMarginPct": { "title": "Target gross margin (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Global target; individual products may override. Gross margin excludes sales commissions (shown separately).", "default": 35 }, "targetCurrency": { "title": "Reporting currency", "pattern": "^[A-Z]{3}$", "maxLength": 3, "type": "string", "description": "ISO 4217 uppercase 3-letter currency. Missing FX means incomparable.", "default": "USD" }, "fxRates": { "title": "Customer-provided FX to reporting currency", "type": "object", "description": "Optional: quote/sale currency -> number of reporting currency units per ONE foreign currency unit. E.g. EUR:1.1, no live FX.", "default": {} }, "asOf": { "title": "Quote evaluation date (UTC)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD; omitted means current UTC date." }, "maxResults": { "title": "Maximum reviewed quotes", "minimum": 1, "maximum": 500, "type": "integer", "description": "Input order preserved. No source data leaves Apify.", "default": 100 } } }, "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 } } } } } } } } } }