Jump to Content
Home
Guides
API Reference
Changelog
v1.0
Knowledge Base
Log In
API Reference
Knowledge Base
Log In
v1.0
Home
Guides
API Reference
Changelog
The stocktake object
All
Pages
Start typing to search…
JUMP TO
KATANA API
Introduction
Authentication
Filtering
HTTP status codes
Pagination
Rate limiting
Versioning
Webhooks
RESOURCES
Additional costs
List all additional costs
get
Batch
Create a batch
post
List current batch stock
get
Update batch details
patch
BOM row
The BOM row object
Create a BOM row
post
List all BOM rows
get
Create many BOM rows
post
Update a BOM row
patch
Delete a BOM row
del
Customer
The customer object
Create a customer
post
List all customers
get
Update a customer
patch
Delete a customer
del
Customer address
The customer address object
List all customer addresses
get
Create a customer address
post
Update a customer address
patch
Delete a customer address
del
Custom fields
List all custom fields collections
get
Storage bin
List all storage bins
get
Update a storage bin
patch
Delete a storage bin
del
The storage bin object
Factory
Retrieve the current factory
get
Inventory
The inventory object
List current inventory
get
Update the reorder point
post
Update the safety stock level
post
List all variants with negative stock
get
Inventory movements
List all inventory movements
get
Location
The location object
List all locations
get
Retrieve a location
get
Manufacturing order
The manufacturing order object
Create a manufacturing order
post
List all manufacturing orders
get
Retrieve a manufacturing order
get
Update a manufacturing order
patch
Delete a manufacturing order
del
Create a make-to-order manufacturing order
post
Unlink a manufacturing order from sales order row
post
List all manufacturing orders
get
Manufacturing order production
The manufacturing order production object
Create a manufacturing order production
post
Retrieve a manufacturing order production
get
Update a manufacturing order production
patch
Delete a manufacturing order production
del
Manufacturing order production ingredient
Update a manufacturing order production ingredient
patch
Manufacturing order operation
The manufacturing order operation row object
Create a manufacturing order operation row
post
List all manufacturing order operation rows
get
Retrieve a manufacturing order operation row
get
Update a manufacturing order operation row
patch
Delete a manufacturing order operation row
del
Manufacturing order recipe
The manufacturing order recipe row object
Create a manufacturing order recipe row
post
List all manufacturing order recipe rows
get
Retrieve a manufacturing order recipe row
get
Update a manufacturing order recipe row
patch
Delete a manufacturing order recipe row
del
Material
The material object
Create a material
post
List all materials
get
Retrieve a material
get
Update a material
patch
Delete a material
del
Operator
Get all operators
get
Outsourced purchase order recipe row
The outsourced purchase order recipe row object
Create an outsourced purchase order recipe row
post
List all outsourced purchase order recipe rows
get
Retrieve an outsourced purchase order recipe row
get
Update an outsourced purchase order recipe row
patch
Delete outsourced purchase order recipe row
del
Price list
Create a price list
post
List all price lists
get
Update a price list
patch
Delete a price list
del
Retrieve a price list
get
Price list rows
Create price list rows
post
List all price list rows
get
Update a price list row
patch
Delete price list row
del
Retrieve a price list row
get
Price list customers
Create price list customers
post
List all price list customers
get
Update a price list customer
patch
Delete a price list customer
del
Retrieve a price list customer
get
Product
The product object
Create a product
post
List all products
get
Retrieve a product
get
Update a product
patch
Delete a product
del
Product operation
The product operation object
Create product operations
post
List all product operations
get
Update a product operation row
patch
Delete a product operation row
del
Change the product operation's rank
post
Purchase order
The purchase order object
Create a purchase order
post
List all purchase orders
get
Retrieve a purchase order
get
Update a purchase order
patch
Delete purchase order
del
Receive a purchase order
post
Purchase order additional cost row
Create a purchase order additional cost row
post
List all purchase order additional cost rows
get
Retrieve a purchase order additional cost row
get
Update a purchase order additional cost row
patch
Delete a purchase order additional cost row
del
Purchase order row
The purchase order row object
Create a purchase order row
post
List all purchase order rows
get
Retrieve a purchase order row
get
Update a purchase order row
patch
Delete purchase order row
del
Purchase order accounting metadata
The purchase order accounting metadata object
List all purchase order accounting metadata
get
Recipe
The recipe / BOM object
Create recipes
post
List all recipes
get
Update a recipe row
patch
Delete a recipe row
del
Sales order
The sales order object
Create a sales order
post
List all sales orders
get
Retrieve a sales order
get
Update a sales order
patch
Delete sales order
del
Get returnable items
get
Sales order address
The sales order address object
List all sales order addresses
get
Create a sales order address
post
Update a sales order address
patch
Delete sales order address
del
Sales order fulfillment
The sales order fulfillment object
Create a sales order fulfillment
post
List all sales order fulfillments
get
Retrieve a sales order fulfillment
get
Update a sales order fulfillment
patch
Delete a sales order fulfillment
del
Sales order row
The sales order row object
List all sales order rows
get
Create a sales order row
post
Retrieve a sales order row
get
Update a sales order row
patch
Delete sales order row
del
Sales order accounting metadata
List all sales order accounting metadata
get
Sales order shipping fee
Creates a sales order shipping fee and add it to sales order
post
List all shipping fees
get
Retrieve a shipping fee
get
Update a shipping fee
patch
Deletes shipping fee, also removes it from attached sales order.
del
Sales return
The sales return object
Create a sales return
post
List all sales returns
get
Retrieve a sales return
get
Update a sales return
patch
Delete sales return
del
Get return reasons
get
Sales return row
The sales return row object
Create a sales return row
post
List all sales return rows
get
Retrieve a sales return row
get
Update a sales return row
patch
Delete sales return row
del
Retrieve unassigned batch transactions for a sales return row
get
Serial number
The serial number object
Returns a list of serial numbers
get
Assign serial numbers to a resource
post
Unassign serial numbers from a resource
del
Serial number stock
The serial number stock object
Returns a list of in-stock serial numbers
get
Stock adjustment
The stock adjustment object
Create a stock adjustment
post
List all stock adjustments
get
Update a stock adjustment
patch
Delete a stock adjustment
del
Stock transfer
The stock transfer object
Create a stock transfer
post
List all stock transfers
get
Update a stock transfer
patch
Delete a stock transfer
del
Update stock transfers status
patch
Stocktake
The stocktake object
Create a stocktake
post
List all stocktakes
get
Update a stocktake
patch
Delete a stocktake
del
Stocktake row
The stocktake row object
Create stocktake rows
post
List all stocktake rows
get
Update a stocktake row
patch
Delete a stocktake row
del
Supplier
The supplier object
Create a supplier
post
List all suppliers
get
Update a supplier
patch
Delete a supplier
del
Supplier address
List all supplier addresses
get
Create a supplier address
post
Update a supplier address
patch
Delete a supplier address
del
Tax rate
The tax rate object
Create a tax rate
post
List all tax rates
get
User
List all users
get
Variant
The variant object
Create a variant
post
List all variants
get
Retrieve a variant
get
Update a variant
patch
Delete a variant
del
Variant default storage bin
Link variant default storage bins
post
Unlink variant default storage bins
post
The variant default storage bin object
Webhook
The webhook object
Create a webhook
post
List all webhooks
get
Retrieve a webhook
get
Update a webhook
patch
Delete webhook
del
Webhook logs
Export webhook logs
post
Service
The service object
List all services
get
Create a service
post
Retrieve a service
get
Update a service
patch
Delete a service
del
Demand forecast
Demand forecast object
List planned demand forecast for variant in location
get
Add planned demand forecast to variant.
post
Clear planned demand forecast to variant.
del
The stocktake object
Ask AI
