Proud winners of the 2026 CFIN Foodtech Frontier Awards. Learn more →

API Reference

Actions

  • POST /flow/actions/adjust Adjust Quantities
  • POST /flow/actions/assign Assign Entity
  • POST /flow/actions/bundle Bundle Entities
  • POST /flow/actions/make Make Product
  • POST /flow/actions/merge Merge Entities
  • POST /flow/actions/move Move Inventory
  • POST /flow/actions/receive Receive Inventory
  • POST /flow/actions/split Split Lot
  • POST /flow/actions/unassign Unassign Entity
  • POST /flow/actions/unmerge Unmerge Entity
  • POST /flow/actions/update Update Entity
  • POST /flow/actions/waste Waste Inventory

Inventory

  • GET /flow/{flowId}/entities List Inventory

Purchase Orders

  • GET /purchase-orders List Purchase Orders
  • POST /purchase-orders Create Purchase Order
  • GET /purchase-orders/{id} Get Purchase Order Details
  • PUT /purchase-orders/{id} Update Purchase Order
  • DELETE /purchase-orders/{id} Delete Purchase Order

Orders

  • GET /orders List Orders
  • POST /orders Create Order
  • GET /orders/{id} Get Order Details
  • PUT /orders/{id} Update Order
  • DELETE /orders/{id} Delete Order
  • GET /orders/{id}/product-attributes Get Order Product Attributes
  • GET /orders/{id}/progress Get Order Progress

Shipments

  • GET /shipments List Shipments
  • POST /shipments Create Shipment
  • GET /shipments/{id} Get Shipment Details
  • PUT /shipments/{id} Update Shipment
  • DELETE /shipments/{id} Delete Shipment
  • PATCH /shipments/{id} Patch Shipment
  • GET /shipments/{id}/captured-entities Get Captured Entities and Nodes
  • POST /shipments/{id}/complete-sync Complete Shipment Synchronously (Test Only)
  • GET /shipments/{id}/items Get Shipment Items
  • GET /shipments/orderId/{orderId} Get Shipments For Order

Products

  • GET /products List Products
  • PUT /products Batch Update Products
  • POST /products Create Product
  • GET /products/{id} Get Product Details
  • PUT /products/{id} Update Product
  • DELETE /products/{id} Delete Product
  • POST /products/{id}/gtins Add Product GTIN
  • DELETE /products/{id}/gtins/{gtinId} Delete Product GTIN
  • GET /products/{id}/supplier-planning-rules List Supplier Planning Rules
  • PUT /products/{id}/supplier-planning-rules/{supplierId} Update Supplier Planning Rule
  • DELETE /products/{id}/supplier-planning-rules/{supplierId} Delete Supplier Planning Rule
  • POST /products/fetch-by-ids Fetch Products by IDs

Recipes

  • GET /recipes List Recipes
  • POST /recipes Create Recipe
  • GET /recipes/{id} Get Recipe Details
  • PUT /recipes/{id} Update Recipe
  • DELETE /recipes/{id} Delete Recipe
  • GET /recipes/{id}/entities-for-input/{inputIndex} Get Entities for Recipe Input

Suppliers

  • GET /suppliers List Suppliers
  • POST /suppliers Create Supplier
  • GET /suppliers/{id} Get Supplier Details
  • PUT /suppliers/{id} Update Supplier
  • DELETE /suppliers/{id} Delete Supplier
  • PATCH /suppliers/{id} Patch Supplier
  • GET /suppliers/{id}/default-purchase-order Get Supplier Default Order
  • GET /suppliers/{id}/products Get Supplier Products

Customers

  • GET /customers List Customers
  • POST /customers Create Customer
  • GET /customers/{id} Get Customer Details
  • PUT /customers/{id} Update Customer
  • DELETE /customers/{id} Delete Customer
  • PATCH /customers/{id} Patch Customer
  • GET /customers/{id}/recent-activity Get Customer Recent Activity

Carriers

  • GET /transports List Carriers
  • POST /transports Create Carrier
  • GET /transports/{id} Get Carrier Details
  • PUT /transports/{id} Update Carrier
  • DELETE /transports/{id} Delete Carrier

Forms

  • GET /forms List Forms
  • POST /forms Create Form
  • GET /forms/{id} Get Form Details
  • PUT /forms/{id} Update Form
  • DELETE /forms/{id} Delete Form

Plans

  • GET /work/plans listPlans
  • POST /work/plans createPlan
  • GET /work/plans/{id} getPlanById
  • PUT /work/plans/{id} updatePlan
  • DELETE /work/plans/{id} deletePlan

Tasks

  • GET /work/tasks listTasks
  • GET /work/tasks/{stepId} getTask

Customer Forecasting

  • GET /forecasting/customer-product/{productId}/{customerCode}/predictions Get customer predictions
  • GET /forecasting/customer-product/{productId}/customers List customers for a product
  • GET /forecasting/customer-product/customers List customers with sales data
  • GET /forecasting/customer-product/training-jobs/{jobId} Get customer training job

Labels

  • GET /labels Get Labels
  • POST /labels Create Label
  • GET /labels/{id} Get Label
  • PUT /labels/{id} Update Label
  • DELETE /labels/{id} Delete Label