Actions218
- Batch Actions
- Country Actions
- Customer Actions
- Customer Address Actions
- Department Actions
- FAQ Actions
- FAQ Category Actions
- GraphQL Actions
- Markup Master Actions
- Master Option Range Actions
- Master Option Stock Actions
- Master Option Tag Actions
- Mutation Actions
- Add Proof Version
- Assign Options
- Modify Order Product (Beta)
- Set Additional Option (Beta)
- Set Additional Option Attributes (Beta)
- Set Batch
- Set Department
- Set FAQ Category
- Set Markup Master (Legacy Alias)
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Rules (Legacy Alias)
- Set Master Option Tags
- Set Option Formulas
- Set Option Group
- Set Order (Staging)
- Set Order Product
- Set Product
- Set Product Category
- Set Product Design
- Set Product Image Gallery
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU (Staging)
- Set Products Attribute Price (Beta)
- Set Quantity Based Attribute Price (Beta)
- Set Quote
- Set Shipment
- Set Store
- Set Store Address
- Set Store Markup
- Update Order Product Images
- Update Order Status
- Update Ziflow Link (Images)
- Upload Order Product Files From URLs
- Option Formula Actions
- Option Group Actions
- Order Actions
- Order Detail Actions
- Order Product Actions
- Order Shipment Actions
- Payment Term Actions
- Product Actions
- Get Category
- Get Detailed
- Get FAQs
- Get Many Categories
- Get Many Detailed
- Get Many FAQs
- Get Many Master Option Ranges (Legacy)
- Get Many Master Option Tags (Legacy)
- Get Many Master Options
- Get Many Option Groups (Legacy)
- Get Many Option Prices
- Get Many Options Rules
- Get Many Prices
- Get Many Simple
- Get Master Options
- Get Option Prices
- Get Options Rules
- Get Prices
- Get Simple
- Get SKU Matrix (Staging)
- Get Stock
- Set Product SKU (Staging)
- Update Stock
- Product Stock Actions
- Quote Actions
- Quote Product Actions
- Ship To Multiple Actions
- Status Actions
- Store Actions
- Store Address Actions
- Store Markup Actions
- Complete API Actions
- Account Summary
- Admin Extra Field Values
- Admin Extra Fields
- Attributes
- Authenticate Customer
- Customer Address Details
- Customers
- Faq
- Get Batch
- Get Countries
- Get Custom Formula
- Get Departments
- Get Faq Category
- Get Master Option Combination Matrix
- Get Master Option Range
- Get Master Option Stock Configs
- Get Master Option Stock History
- Get Master Option Tag
- Get Option Group
- Get Payment Term Master
- Get Product SKU Matrix
- Get Quote
- Get Store
- Get Store Locations
- Get Store Markup
- Get User Basket
- Order Billing Details
- Order Blind Details
- Order Delivery Details
- Order Products
- Order Shipment Details
- Order Status
- Order Summary
- Orders
- Product Additional Options
- Product Category
- Product Master Options
- Product Option Rules
- Product Options Price
- Product Price
- Product Size
- Product Stocks
- Products
- Products Attribute Price
- Products Details
- Products Image Gallery
- Quantity Based Attribute Price
- Quoteproduct
- Ship To Multiple Address
- Store Credit Summary
- Storeaddress
- Validate Customer Token
- Add Master Option Stock Config
- Delete Master Option Stock Config
- Modify Order Product
- Notify User
- Set Additional Option
- Set Additional Option Attributes
- Set Admin Extra Field
- Set Admin Extra Field Values
- Set Assign Options
- Set Batch
- Set Batch Job
- Set Custom Formula
- Set Customer
- Set Customer Address Detail
- Set Department
- Set Faq
- Set Faq Category
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Range
- Set Master Option Stock Settings
- Set Master Option Tag
- Set Option Group
- Set Order
- Set Order Product
- Set Order Product Image
- Set Order Product Image From URL
- Set Product
- Set Product Category
- Set Product Design
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU
- Set Products Attribute Price
- Set Products Image Gallery
- Set Quantity Based Attribute Price
- Set Quote
- Set Shipment
- Set Store
- Set Store Address
- Set Store Location
- Set Store Markup
- Set User Basket
- Update Master Option Stock
- Update Order Status
- Update Product Stock
Complete API → Product Stocks
AI-generatedSummary
Reads OnPrintShop product stock records through the Complete API productStocks query.
Inputs
- safeMode — In Complete API, enabling Safe Mode blocks mutations. This operation is read-only, so Safe Mode is not needed for normal use.
- apiInputMode (required) — Select Fields to build the request from individual form fields, or JSON Object to supply the query arguments as a JSON object.
- api_type (required) — Required stock scope when Input Mode is Fields. Select Product Option (product_option) or Product (product).
- apiOptional — Optional query parameters in Fields mode: Limit, Offset, and Product ID. Product ID filters stock records for a specific product; Limit and Offset control pagination.
- apiArgumentsJson — Used when Input Mode is JSON Object. Provide the API arguments for the productStocks query as a JSON object instead of using the Type and Parameters form.
- apiReturnMode (required) — Choose All Fields to return the full productStocks response, or Custom Selection to return only the fields you select.
- apiReturnFields — When Return Fields Mode is Custom Selection, choose from currentCount, totalProductStocks, and per-stock fields: stock_id, product_id, product_name, size_id, size_title, credited_stock, current_stock, debited_stock, option_details, and location.
Output shape
Returns the productStocks query response data: matching product stock records with the requested fields, plus totalProductStocks and currentCount counts when those fields are selected.
In All Fields mode, the full available stock field set is returned. In Custom Selection mode, only the selected fields are requested.
Examples
Example 1: Check current stock for a product
Set Resource to Complete API, Operation to Product Stocks, Input Mode to Fields, Type to Product, add Product ID in Parameters, and use Return Fields Mode All Fields.
Example 2: Check product option stock with custom fields
Set Input Mode to Fields, Type to Product Option, optionally add Limit/Offset, set Return Fields Mode to Custom Selection, and select fields such as productStocks.stock_id, productStocks.product_name, and productStocks.current_stock.