Products
List Faire Products
List Faire products synced for a specific integration instance.
List Products for Instance (Variants Listing)
Paginated list of `FaireProductOption` rows (variants) for one Faire integration instance. Powers the **Faire → Products** listing page in Vue 3.
Get Products Latest Sync Info
Aggregate stats about the products previously synced from Faire. Used by the **Refresh from Faire** modal header to show how much data is currently cached locally and which mode of refresh is appropriate.
Get Variant Filter Options (Distinct Product Types)
Returns distinct values for the variant listing's filter dropdowns. Currently only `product_types` (sourced from `faire_products.product_type`, populated from Faire's taxonomy `taxonomy_type.name`).
Refresh Products from Faire (Tracked)
Dispatches a `RefreshFaireProductsTrackedJob` background job that walks the Faire catalog and persists `faire_products` + `faire_product_options`. Returns immediately with a tracked job log ID — progress is visible in the global Job Progress Tray.
Bulk Operation (Synchronous)
Run a bulk action on Faire product options synchronously and return the result inline. Best for **Selected Only** requests where the count is small and the operation completes in well under HTTP timeout. For **All Filtered** requests that may exceed timeout, use the tracked variant instead.
Bulk Operation (Tracked)
Dispatches a `BulkFaireProductOperationTrackedJob` background job that performs the bulk action across the resolved selection. Returns immediately with a tracked job log ID — progress is visible in the global Job Progress Tray and pollable via the `bulk-progress` endpoint.
Bulk Operation Progress
Returns the live progress of a `BulkFaireProductOperationTrackedJob`. Returns the standard `TrackedJobLogResource` shape — same as the global Job Progress Tray polls. Poll this endpoint while the job runs; `progress_percentage` and `results` update as the job processes batches.
Map Single Variant to SKU.io Product
Maps a single Faire product variant (option) to an existing SKU.io product. Used by the per-row Map button on the Faire products page.
Unmap Single Variant
Removes the SKU.io product link for a single Faire variant by deleting the associated `product_listings` row. Idempotent — calling on a variant that wasn't mapped returns `data.unmapped = false` with status 200.
Find Smart-Match Candidates
Suggests SKU.io products to map a Faire variant to. Used by the per-row mapping modal to power the **Smart Match** section.
Create SKU.io Product from Variant
Creates a new SKU.io product from a Faire variant's data and links the variant to it via a `product_listings` row. Used by the **Create New SKU Product** action in the per-row mapping modal.
Get Variant Detail
Detail view of a single `FaireProductOption` (variant), powering the Faire variant detail page in Vue 3.
Get Raw Data from Faire (Variant)
Lazy-loaded raw payload from Faire for a single variant's parent product. Used by the Faire variant detail page's collapsible 'Raw Data from Faire' panel — only fetched when the panel is opened.
List Products
List all products with DataTable support. Supports searching, sorting, filtering, pagination, and column selection.
Create Product
Create a new product.
Bulk Delete Products
Bulk delete multiple products. For large datasets, deletion is processed in the background via a queue.
Get Product
Get a single product by ID with all related data.
Update Product
Update an existing product by ID. All fields are optional on update.
Delete Product
Delete a product by ID. Deletion fails if the product is linked to sales orders, purchase orders, inventory movements, or bundles.
Get Product by SKU
Get a product by its exact SKU.
Get Product Constants
Returns enumeration constants used in product forms: product types, weight units, dimension units, attribute types, warehouse types, and inventory movement types.
Get Create Product Form
Returns the data needed to pre-populate the create product form (delegates to DataTable trait).
Get Edit Product Form
Returns the product data pre-populated for the edit form.
List Products
List all products with DataTable support. Supports searching, sorting, filtering, pagination, and column selection.
Create Product
Create a new product.
Bulk Delete Products
Bulk delete multiple products. For large datasets, deletion is processed in the background via a queue.
Get Product
Get a single product by ID with all related data.
Update Product
Update an existing product by ID. All fields are optional on update.
Delete Product
Delete a product by ID. Deletion fails if the product is linked to sales orders, purchase orders, inventory movements, or bundles.
Get Product by SKU
Get a product by its exact SKU.
Get Product Constants
Returns enumeration constants used in product forms: product types, weight units, dimension units, attribute types, warehouse types, and inventory movement types.
Get Create Product Form
Returns the data needed to pre-populate the create product form (delegates to DataTable trait).
Get Edit Product Form
Returns the product data pre-populated for the edit form.
Search Products
Search products by SKU, name, or barcode. Results are ranked by a 9-tier relevance scheme so typing a full SKU surfaces the exact product first:
Barcode Lookup
Exact-match barcode or SKU lookup for barcode scanning. Prioritises barcode match first, then falls back to SKU match. Only active products are returned. Returns null in data if no match found.
Check Product Deletability
Check whether one or more products can be safely deleted. Returns deletability status with reasons and usage record samples for each product.
Search Products
Search products by SKU, name, or barcode. Results are ranked by a 9-tier relevance scheme so typing a full SKU surfaces the exact product first:
Barcode Lookup
Exact-match barcode or SKU lookup for barcode scanning. Prioritises barcode match first, then falls back to SKU match. Only active products are returned. Returns null in data if no match found.
Check Product Deletability
Check whether one or more products can be safely deleted. Returns deletability status with reasons and usage record samples for each product.
Archive Product
Archive a product by ID. Sets archived_at timestamp.
Unarchive Product
Unarchive a product by ID. Clears the archived_at timestamp.
Bulk Archive Products
Bulk archive multiple products.
Bulk Unarchive Products
Bulk unarchive multiple products.
Archive Product
Archive a product by ID. Sets archived_at timestamp.
Unarchive Product
Unarchive a product by ID. Clears the archived_at timestamp.
Bulk Archive Products
Bulk archive multiple products.
Bulk Unarchive Products
Bulk unarchive multiple products.
Get Product Inventory
Get detailed inventory breakdown for a product across all warehouses. Includes FBA real-time data, Pan-EU rollup, supplier drop-ship inventory, and purchase order inbound quantities.
Get Product Inventory Movements
Get paginated inventory movements for a specific product with DataTable support.
Get Product FIFO Layers
Get FIFO cost layers for a specific product.
Get FBA Inventory
Get FBA real-time inventory details for a product in a specific Amazon FBA warehouse.
Refresh Inventory Cache
Synchronously refreshes the inventory cache for a specific product. This forces a recalculation of inventory totals and average cost.
Get Sales Channel Inventory
Get inventory broken down by sales channel for a specific product.
Get Last Purchase Price
Get the most recent purchase price for a product from non-draft purchase orders.
Get Product Inventory
Get detailed inventory breakdown for a product across all warehouses. Includes FBA real-time data, Pan-EU rollup, supplier drop-ship inventory, and purchase order inbound quantities.
Get Product Inventory Movements
Get paginated inventory movements for a specific product with DataTable support.
Get Product FIFO Layers
Get FIFO cost layers for a specific product.
Get FBA Inventory
Get FBA real-time inventory details for a product in a specific Amazon FBA warehouse.
Refresh Inventory Cache
Synchronously refreshes the inventory cache for a specific product. This forces a recalculation of inventory totals and average cost.
Get Sales Channel Inventory
Get inventory broken down by sales channel for a specific product.
Get Last Purchase Price
Get the most recent purchase price for a product from non-draft purchase orders.
Get Product Attributes
Get all available attributes for a product, including direct attributes and those inherited from category attribute groups.
Update Product Attributes
Add or update attributes on a product. Syncs without detaching other existing attributes.
Delete Product Attributes
Remove specific attributes from a product by attribute IDs.
Get Product Attributes Grouped
Get product attributes organised into grouped (by attribute group) and direct (ungrouped) sections.
Assign Attribute Groups
Sync attribute groups assigned to a product. This replaces all current attribute group assignments.
Get All Attributes for Products
Get unique variant attributes across multiple products. Used by mapping modals.
Get Product Attributes
Get all available attributes for a product, including direct attributes and those inherited from category attribute groups.
Update Product Attributes
Add or update attributes on a product. Syncs without detaching other existing attributes.
Delete Product Attributes
Remove specific attributes from a product by attribute IDs.
Get Product Attributes Grouped
Get product attributes organised into grouped (by attribute group) and direct (ungrouped) sections.
Assign Attribute Groups
Sync attribute groups assigned to a product. This replaces all current attribute group assignments.
Get All Attributes for Products
Get unique variant attributes across multiple products. Used by mapping modals.
Get Product Suppliers
Get all supplier relationships for a product, including pricing tiers per supplier.
Set Default Supplier
Mark a supplier as the default supplier for a product. Clears the is_default flag from all other suppliers for this product.
Get Product Components
Get all component products for a bundle or kit product.
Get Product Bundles
Get all bundles that this product is a component of.
Get Potential Bundles
Calculate potential bundle quantities for a kit product based on current stock of its components per warehouse and inventory status.
Get Product Suppliers
Get all supplier relationships for a product, including pricing tiers per supplier.
Set Default Supplier
Mark a supplier as the default supplier for a product. Clears the is_default flag from all other suppliers for this product.
Get Product Components
Get all component products for a bundle or kit product.
Get Product Bundles
Get all bundles that this product is a component of.
Get Potential Bundles
Calculate potential bundle quantities for a kit product based on current stock of its components per warehouse and inventory status.
Get Product Variations
Get all variation products for a matrix (parent) product.
Get Variation Attributes
Get unique variant attributes used across all variations of a matrix product.
Get Product Variations
Get all variation products for a matrix (parent) product.
Get Variation Attributes
Get unique variant attributes used across all variations of a matrix product.
List Product Images
Get all images for a product.
Add Product Image
Add a new image to a product. The `image` field accepts EITHER an uploaded file (multipart/form-data) OR a URL / base64 string (application/json).
Bulk Update/Create Product Images
Bulk update or create multiple images for a product at once.
List Product Images
Get all images for a product.
Add Product Image
Add a new image to a product. The `image` field accepts EITHER an uploaded file (multipart/form-data) OR a URL / base64 string (application/json).
Bulk Update/Create Product Images
Bulk update or create multiple images for a product at once.
List Product Listings
Get paginated product listings (channel listings) for a specific product with DataTable support. Refreshes inventory cache for all listings before returning.
List Product Listings
Get paginated product listings (channel listings) for a specific product with DataTable support. Refreshes inventory cache for all listings before returning.
Create Blemished Product
Create a blemished (damaged/used) product derived from an existing standard product.
Generate Blemished SKU Pattern
Generate a blemished SKU based on the tenant's blemished SKU pattern settings and the original product's SKU.
Create Blemished Product
Create a blemished (damaged/used) product derived from an existing standard product.
Generate Blemished SKU Pattern
Generate a blemished SKU based on the tenant's blemished SKU pattern settings and the original product's SKU.
Get Import Fields
Returns dynamic import fields including custom attributes for the column mapping UI.
Download Import Template
Download an XLSX import template with headers, sample data, field guide, and reference data from the tenant's account.
Validate Import
Validate mapped import data and return a preview. No data is created — safe to call repeatedly for client-side validation before executing the actual import.
Execute Import
Execute the product import — creates products from the validated data. Should be called after validate.
Preview Import (Legacy CSV)
Legacy endpoint for CSV import preview (delegates to ImportsData trait).
Get Import Fields
Returns dynamic import fields including custom attributes for the column mapping UI.
Download Import Template
Download an XLSX import template with headers, sample data, field guide, and reference data from the tenant's account.
Validate Import
Validate mapped import data and return a preview. No data is created — safe to call repeatedly for client-side validation before executing the actual import.
Execute Import
Execute the product import — creates products from the validated data. Should be called after validate.
Preview Import (Legacy CSV)
Legacy endpoint for CSV import preview (delegates to ImportsData trait).
Download Merge Template
Download a CSV template for bulk product merging. Contains columns: old_sku, destination_sku.
Upload Merge CSV
Upload a CSV file with product merge pairs. Validates the SKU pairs and creates a session (cached for 2 hours) for preview and execution.
Create Merge Session (Single Pair)
Create a merge session for a single SKU pair without uploading a CSV. Validates that both SKUs exist and are compatible.
Get Merge Preview
Get a preview of what will happen when the merge is executed. Shows data changes for each SKU pair.
Execute Merge
Execute the product merge for all pairs in the session. Merges sales order lines, purchase order lines, and other references from the old SKU to the destination SKU. Clears the session cache after execution.
Download Merge Template
Download a CSV template for bulk product merging. Contains columns: old_sku, destination_sku.
Upload Merge CSV
Upload a CSV file with product merge pairs. Validates the SKU pairs and creates a session (cached for 2 hours) for preview and execution.
Create Merge Session (Single Pair)
Create a merge session for a single SKU pair without uploading a CSV. Validates that both SKUs exist and are compatible.
Get Merge Preview
Get a preview of what will happen when the merge is executed. Shows data changes for each SKU pair.
Execute Merge
Execute the product merge for all pairs in the session. Merges sales order lines, purchase order lines, and other references from the old SKU to the destination SKU. Clears the session cache after execution.
List Products
Get a paginated list of products using Spatie QueryBuilder.
Get Product
Get a single product with default relations loaded (brand, primaryImage, primaryCategory, tags, defaultSupplierProduct.supplier, totalInventory).
Get Product Inventory
Get inventory breakdown by warehouse for a product.
Get Product Suppliers
Get supplier products for a product, including pricing tiers and supplier inventory.
Get Product Pricing
Get product pricing tiers.
Upsert Product Pricing
Idempotently upsert a single pricing tier price for a product.
Get Product Components
Get components for a bundle or kit product.
Get Parent Products
Get parent bundle/kit products that include this product as a component.
Get Bundle Potential
Get bundle assembly potential — how many units can be assembled from current component inventory.
Get Product Variations
Get variations of a matrix product.
Get Product Images
Get all images for a product, sorted by sort_order.
Get Product Listings
Get paginated sales channel listings for a product.
Get Product Listings Summary
Get listing counts grouped by integration for a product.
Get Product Inventory Movements
Get paginated inventory movements for a product.
Get Product FIFO Layers
Get paginated FIFO cost layers for a product.
Get Product Activity Log
Get paginated activity log for a product (covers Product and SupplierProductPricing events).
Get Product Notes
Get notes for a product, sorted by most recent first.
Get Product Purchase Order Lines
Get purchase order lines for a product, filtered by status.
Get Product Inventory Tally
Get enriched inventory tally data for a product at a specific warehouse.
Get Product Reservation Integrity
Get reservation integrity issues for a product.
Get Product Active Reservations
Get active (outstanding) inventory reservations for a product.
Get Product Warehouse Transfer Lines
Get warehouse transfer lines for a product, showing in-transit or received quantities.
Get Product Holds
Get inventory holds for a product.
List Products
Get a paginated list of products using Spatie QueryBuilder.
Get Product
Get a single product with default relations loaded (brand, primaryImage, primaryCategory, tags, defaultSupplierProduct.supplier, totalInventory).
Get Product Inventory
Get inventory breakdown by warehouse for a product.
Get Product Suppliers
Get supplier products for a product, including pricing tiers and supplier inventory.
Get Product Pricing
Get product pricing tiers.
Upsert Product Pricing
Idempotently upsert a single pricing tier price for a product.
Get Product Components
Get components for a bundle or kit product.
Get Parent Products
Get parent bundle/kit products that include this product as a component.
Get Bundle Potential
Get bundle assembly potential — how many units can be assembled from current component inventory.
Get Product Variations
Get variations of a matrix product.
Get Product Images
Get all images for a product, sorted by sort_order.
Get Product Listings
Get paginated sales channel listings for a product.
Get Product Listings Summary
Get listing counts grouped by integration for a product.
Get Product Inventory Movements
Get paginated inventory movements for a product.
Get Product FIFO Layers
Get paginated FIFO cost layers for a product.
Get Product Activity Log
Get paginated activity log for a product (covers Product and SupplierProductPricing events).
Get Product Notes
Get notes for a product, sorted by most recent first.
Get Product Purchase Order Lines
Get purchase order lines for a product, filtered by status.
Get Product Inventory Tally
Get enriched inventory tally data for a product at a specific warehouse.
Get Product Reservation Integrity
Get reservation integrity issues for a product.
Get Product Active Reservations
Get active (outstanding) inventory reservations for a product.
Get Product Warehouse Transfer Lines
Get warehouse transfer lines for a product, showing in-transit or received quantities.
Get Product Holds
Get inventory holds for a product.
Get Bulk Edit Metadata
Get dynamic field metadata for the bulk edit UI: attributes (with options), pricing tiers, supplier pricing tiers, and suppliers.
Fetch Products for Bulk Edit
Fetch products with all editable fields loaded for the bulk edit page.
Bulk Edit Products (Apply to All)
Apply the same set of changes to all selected products.
Bulk Edit Products (Individual)
Apply individual per-product changes.
Preview Bulk Edit
Preview bulk edit changes without applying them (dry run). Safe to call repeatedly.
Get Bulk Edit Metadata
Get dynamic field metadata for the bulk edit UI: attributes (with options), pricing tiers, supplier pricing tiers, and suppliers.
Fetch Products for Bulk Edit
Fetch products with all editable fields loaded for the bulk edit page.
Bulk Edit Products (Apply to All)
Apply the same set of changes to all selected products.
Bulk Edit Products (Individual)
Apply individual per-product changes.
Preview Bulk Edit
Preview bulk edit changes without applying them (dry run). Safe to call repeatedly.
List Bundle Workshop Products
List all bundle/kit products with component counts and configuration status.
Auto-Detect Bundle Candidates
Auto-detect standard products that may be bundles/kits based on naming patterns.
Batch Convert Products to Bundle/Kit
Batch convert standard products to bundle/kit types.
Check Bundle Restrictions
Check which products have sale/assembly inventory movements that would restrict type changes.
Get Bundle Components
Get components for a specific bundle/kit product in the Bundle Workshop.
Save Bundle Components
Save/sync components for a bundle/kit. Replaces all existing components.
Get Restricting Movements
Get paginated sale/assembly inventory movements that restrict type changes for a product.
Update Bundle Type
Update the type of an existing bundle/kit product (bundle ↔ kit ↔ standard).
List Bundle Workshop Products
List all bundle/kit products with component counts and configuration status.
Auto-Detect Bundle Candidates
Auto-detect standard products that may be bundles/kits based on naming patterns.
Batch Convert Products to Bundle/Kit
Batch convert standard products to bundle/kit types.
Check Bundle Restrictions
Check which products have sale/assembly inventory movements that would restrict type changes.
Get Bundle Components
Get components for a specific bundle/kit product in the Bundle Workshop.
Save Bundle Components
Save/sync components for a bundle/kit. Replaces all existing components.
Get Restricting Movements
Get paginated sale/assembly inventory movements that restrict type changes for a product.
Update Bundle Type
Update the type of an existing bundle/kit product (bundle ↔ kit ↔ standard).
Download Supplier Link Template
Download the supplier link import template XLSX.
Validate Supplier Link Import
Validate supplier link import data and return a preview.
Import Supplier Links
Import validated supplier links to create/update supplier-product associations.
Get Import Fields
Get dynamic import fields (custom attributes) for the column mapping UI.
Download Import Template
Download an XLSX import template with headers, sample data, field guide, and reference data.
Validate Product Import
Validate mapped import data and return a preview. No side effects — safe to call repeatedly.
Import Products
Execute the import — create products from validated data.
Download Supplier Link Template
Download the supplier link import template XLSX.
Validate Supplier Link Import
Validate supplier link import data and return a preview.
Import Supplier Links
Import validated supplier links to create/update supplier-product associations.
Export Product List
Export products as XLSX or CSV.
Export Product List
Export products as XLSX or CSV.
Download Export File
Download a completed products export file produced by a queued export tracked job.
Download Export File
Download a completed products export file produced by a queued export tracked job.
List Products
List all Temu products for an integration instance.
Get Product
Get details of a specific Temu product.
Refresh Products
Refresh products from Temu.
Refresh Products (Tracked)
Tracked product refresh that surfaces progress in the global job tray.
Get Latest Product Sync Info
Get summary statistics for the Temu products sync.
Smart Match Product
Find smart matches for a Temu product against SKU products. Used by the ProductMappingModal to surface an exact match (by external SKU or Temu SKU) plus fuzzy name matches.
Map Single Product
Map a single Temu product to a SKU product (or to a subscription offering).
Unmap Single Product
Unmap a single Temu product from its current SKU product mapping. Deletes the underlying `product_listings` row. Returns 422 if the product is not currently mapped.
Create SKU Product From Temu Product
Create a new SKU.io product from a Temu product's data and link it via a product listing. If an existing SKU product with the same SKU already exists, it links to it instead. Returns 422 if the Temu product is already mapped.
Create SKU Products
Create SKU.io products from Temu products.
Map Products
Map Temu products to SKU.io products.
Export Products
Export Temu products to CSV.
Download Product Mappings CSV
Download product mappings as CSV template.
Import Product Mappings
Import product mappings from CSV.
Sync Inventory
Sync inventory levels to Temu.
Archive Products
Archive Temu products.
Unarchive Products
Unarchive Temu products.
Get Archiveable Products
Get products that can be archived.
Delete Products
Delete Temu products.
Get Deleteable Products
Get products that can be deleted.
Refresh Products (Tracked)
Dispatch a tracked background job to re-fetch products from WooCommerce.
Search WooCommerce Products
Search products on the remote WooCommerce store. Used by the Refresh modal's Search Specific Product tab to locate a product and offer a one-click download.
Refresh Single Product
Fetch a single product (and its variations) from WooCommerce and persist it locally. Used by the Refresh modal's Search Specific Product tab download button.
Get Products Latest Sync Info
Return summary information about the locally-cached WooCommerce products for a single integration instance.