Skip to content
Katana OpenAPI Client
stocktake_status
Initializing search
dougborg/katana-openapi-client
Home
Client
MCP Server
API Reference
OpenAPI Documentation
Development
Monorepo ADRs
Katana OpenAPI Client
dougborg/katana-openapi-client
Home
Client
Client
User Guide
Cookbook
Testing
Changelog
ADRs
ADRs
Overview
ADR-001 Transport-Layer Resilience
ADR-002 OpenAPI Code Generation
ADR-003 Transparent Pagination
ADR-004 Defer Observability to httpx
ADR-005 Sync and Async APIs
ADR-006 Response Unwrapping Utilities
ADR-007 Domain Helper Classes
ADR-008 Avoid Builder Pattern (Proposed)
ADR-011 Pydantic Domain Models
ADR-012 Validation Tiers
MCP Server
MCP Server
Overview
Architecture
Development
Deployment
Docker
Implementation Plan
ADRs
ADRs
Overview
ADR-010 Katana MCP Server
API Reference
API Reference
katana_public_api_client
katana_public_api_client
katana_public_api_client
api
api
katana_public_api_client.api
additional_costs
additional_costs
katana_public_api_client.api.additional_costs
get_additional_costs
batch
batch
katana_public_api_client.api.batch
create_batch
get_batch_stock
update_batch_stock
bom_row
bom_row
katana_public_api_client.api.bom_row
batch_create_bom_rows
create_bom_row
delete_bom_row
get_all_bom_rows
update_bom_row
custom_fields
custom_fields
katana_public_api_client.api.custom_fields
get_all_custom_fields_collections
customer
customer
katana_public_api_client.api.customer
create_customer
delete_customer
get_all_customers
update_customer
customer_address
customer_address
katana_public_api_client.api.customer_address
create_customer_address
delete_customer_address
get_all_customer_addresses
update_customer_address
factory
factory
katana_public_api_client.api.factory
get_factory
inventory
inventory
katana_public_api_client.api.inventory
create_inventory_reorder_point
create_inventory_safety_stock_level
get_all_inventory_point
get_all_negative_stock
inventory_movements
inventory_movements
katana_public_api_client.api.inventory_movements
get_all_inventory_movements
location
location
katana_public_api_client.api.location
get_all_locations
get_location
manufacturing_order
manufacturing_order
katana_public_api_client.api.manufacturing_order
create_manufacturing_order
delete_manufacturing_order
get_all_manufacturing_order_productions
get_all_manufacturing_orders
get_manufacturing_order
make_to_order_manufacturing_order
unlink_manufacturing_order
update_manufacturing_order
manufacturing_order_operation
manufacturing_order_operation
katana_public_api_client.api.manufacturing_order_operation
create_manufacturing_order_operation_row
delete_manufacturing_order_operation_row
get_all_manufacturing_order_operation_rows
get_manufacturing_order_operation_row
update_manufacturing_order_operation_row
manufacturing_order_production
manufacturing_order_production
katana_public_api_client.api.manufacturing_order_production
create_manufacturing_order_production
delete_manufacturing_order_production
get_manufacturing_order_production
update_manufacturing_order_production
manufacturing_order_production_ingredient
manufacturing_order_production_ingredient
katana_public_api_client.api.manufacturing_order_production_ingredient
update_manufacturing_order_production_ingredient
manufacturing_order_recipe
manufacturing_order_recipe
katana_public_api_client.api.manufacturing_order_recipe
create_manufacturing_order_recipe_rows
delete_manufacturing_order_recipe_row
get_all_manufacturing_order_recipe_rows
get_manufacturing_order_recipe_row
update_manufacturing_order_recipe_rows
material
material
katana_public_api_client.api.material
create_material
delete_material
get_all_materials
get_material
update_material
operator
operator
katana_public_api_client.api.operator
get_all_operators
price_list
price_list
katana_public_api_client.api.price_list
create_price_list
delete_price_list
get_all_price_lists
get_price_list
update_price_list
price_list_customer
price_list_customer
katana_public_api_client.api.price_list_customer
create_price_list_customer
delete_price_list_customer
get_all_price_list_customers
get_price_list_customer
update_price_list_customer
price_list_row
price_list_row
katana_public_api_client.api.price_list_row
create_price_list_row
delete_price_list_row
get_all_price_list_rows
get_price_list_row
update_price_list_row
product
product
katana_public_api_client.api.product
create_product
delete_product
get_all_products
get_product
update_product
products
products
katana_public_api_client.api.products
create_product_operation_rows
delete_product_operation_row
get_all_product_operation_rows
rerank_product_operations
update_product_operation_row
purchase_order
purchase_order
katana_public_api_client.api.purchase_order
create_purchase_order
delete_purchase_order
find_purchase_orders
get_purchase_order
receive_purchase_order
update_purchase_order
purchase_order_accounting_metadata
purchase_order_accounting_metadata
katana_public_api_client.api.purchase_order_accounting_metadata
get_all_purchase_order_accounting_metadata
purchase_order_additional_cost_row
purchase_order_additional_cost_row
katana_public_api_client.api.purchase_order_additional_cost_row
create_po_additional_cost_row
delete_po_additional_cost
get_po_additional_cost_row
get_purchase_order_additional_cost_rows
update_additional_cost_row
purchase_order_row
purchase_order_row
katana_public_api_client.api.purchase_order_row
create_purchase_order_row
delete_purchase_order_row
get_all_purchase_order_rows
get_purchase_order_row
update_purchase_order_row
purchase_orders
purchase_orders
katana_public_api_client.api.purchase_orders
create_outsourced_purchase_order_recipe_row
delete_outsourced_purchase_order_recipe_row
get_outsourced_purchase_order_recipe_row
get_outsourced_purchase_order_recipe_rows
update_outsourced_purchase_order_recipe_row
recipe
recipe
katana_public_api_client.api.recipe
create_recipes
delete_recipe_row
get_all_recipes
update_recipe_row
sales_order
sales_order
katana_public_api_client.api.sales_order
create_sales_order
delete_sales_order
get_all_sales_orders
get_sales_order
get_sales_order_returnable_items
update_sales_order
sales_order_address
sales_order_address
katana_public_api_client.api.sales_order_address
create_sales_order_address
delete_sales_order_address
get_all_sales_order_addresses
update_sales_order_address
sales_order_fulfillment
sales_order_fulfillment
katana_public_api_client.api.sales_order_fulfillment
create_sales_order_fulfillment
delete_sales_order_fulfillment
get_all_sales_order_fulfillments
get_sales_order_fulfillment
update_sales_order_fulfillment
sales_order_row
sales_order_row
katana_public_api_client.api.sales_order_row
create_sales_order_row
delete_sales_order_row
get_all_sales_order_rows
get_sales_order_row
update_sales_order_row
sales_orders
sales_orders
katana_public_api_client.api.sales_orders
create_sales_order_shipping_fee
delete_sales_order_shipping_fee
get_sales_order_accounting_metadata
get_sales_order_shipping_fee
get_sales_order_shipping_fees
update_sales_order_shipping_fee
sales_return
sales_return
katana_public_api_client.api.sales_return
create_sales_return
delete_sales_return
get_all_sales_returns
get_sales_return
get_sales_return_reasons
update_sales_return
sales_return_row
sales_return_row
katana_public_api_client.api.sales_return_row
create_sales_return_row
delete_sales_return_row
get_all_sales_return_rows
get_sales_return_row
get_sales_return_row_unassigned_batch_transactions
update_sales_return_row
serial_number
serial_number
katana_public_api_client.api.serial_number
create_serial_numbers
delete_serial_numbers
get_all_serial_numbers
get_all_serial_numbers_stock
services
services
katana_public_api_client.api.services
create_service
delete_service
get_all_services
get_service
update_service
stock_adjustment
stock_adjustment
katana_public_api_client.api.stock_adjustment
create_stock_adjustment
delete_stock_adjustment
get_all_stock_adjustments
update_stock_adjustment
stock_transfer
stock_transfer
katana_public_api_client.api.stock_transfer
create_stock_transfer
delete_stock_transfer
get_all_stock_transfers
update_stock_transfer
update_stock_transfer_status
stocktake
stocktake
katana_public_api_client.api.stocktake
create_stocktake
delete_stocktake
get_all_stocktakes
update_stocktake
stocktake_row
stocktake_row
katana_public_api_client.api.stocktake_row
create_stocktake_row
delete_stocktake_row
get_all_stocktake_rows
update_stocktake_row
storage_bin
storage_bin
katana_public_api_client.api.storage_bin
delete_storage_bin
get_all_storage_bins
update_default_storage_bin
supplier
supplier
katana_public_api_client.api.supplier
create_supplier
delete_supplier
get_all_suppliers
update_supplier
supplier_address
supplier_address
katana_public_api_client.api.supplier_address
create_supplier_address
delete_supplier_address
get_supplier_addresses
update_supplier_address
tax_rate
tax_rate
katana_public_api_client.api.tax_rate
create_tax_rate
get_all_tax_rates
user
user
katana_public_api_client.api.user
get_all_users
variant
variant
katana_public_api_client.api.variant
create_variant
delete_variant
get_all_variants
get_variant
update_variant
variant_default_storage_bin
variant_default_storage_bin
katana_public_api_client.api.variant_default_storage_bin
link_variant_default_storage_bins
unlink_variant_default_storage_bins
webhook
webhook
katana_public_api_client.api.webhook
create_webhook
delete_webhook
get_all_webhooks
get_webhook
update_webhook
webhook_logs
webhook_logs
katana_public_api_client.api.webhook_logs
export_webhook_logs
client
client_types
domain
domain
katana_public_api_client.domain
base
converters
material
product
service
variant
errors
helpers
helpers
katana_public_api_client.helpers
base
inventory
materials
products
services
variants
katana_client
log_setup
models
models
katana_public_api_client.models
additional_cost
additional_cost_list_response
archivable_deletable_entity
archivable_entity
assigned_operator
base_entity
base_validation_error
batch
batch_create_bom_rows_request
batch_response
batch_stock
batch_stock_list_response
batch_stock_update
batch_transaction
bom_row
bom_row_list_response
coded_error_response
create_bom_row_request
create_customer_address_request
create_customer_address_request_entity_type
create_customer_request
create_inventory_reorder_point_body
create_manufacturing_order_operation_row_request
create_manufacturing_order_production_request
create_manufacturing_order_recipe_row_request
create_manufacturing_order_recipe_row_request_batch_transactions_item
create_manufacturing_order_request
create_material_request
create_outsourced_purchase_order_recipe_row_body
create_price_list_customer_request
create_price_list_request
create_price_list_row_request
create_product_operation_rows_body
create_product_operation_rows_body_rows_item
create_product_operation_rows_body_rows_item_type
create_product_request
create_product_request_configs_item
create_purchase_order_additional_cost_row_request
create_purchase_order_additional_cost_row_request_distribution_method
create_purchase_order_request
create_purchase_order_request_entity_type
create_purchase_order_request_status
create_purchase_order_row_request
create_recipes_request
create_recipes_request_rows_item
create_sales_order_address_request
create_sales_order_address_request_entity_type
create_sales_order_fulfillment_body
create_sales_order_request
create_sales_order_request_sales_order_rows_item
create_sales_order_request_sales_order_rows_item_attributes_item
create_sales_order_request_status
create_sales_order_row_request
create_sales_order_shipping_fee_request
create_sales_return_request
create_sales_return_row_body
create_sales_return_row_request
create_serial_numbers_body
create_serial_numbers_body_resource_type
create_service_request
create_service_variant_request
create_service_variant_request_custom_fields_item
create_stock_adjustment_request
create_stock_adjustment_request_status
create_stock_adjustment_request_stock_adjustment_rows_item
create_stock_transfer_body
create_stocktake_request
create_stocktake_request_status
create_stocktake_row_request
create_supplier_address_request
create_supplier_request
create_tax_rate_request
create_variant_request
create_variant_request_config_attributes_item
create_variant_request_custom_fields_item
create_webhook_request
custom_field
custom_fields_collection
custom_fields_collection_list_response
custom_fields_collection_resource_type
customer
customer_address
customer_address_entity_type
customer_address_list_response
customer_list_response
deletable_entity
detailed_error_response
enum_validation_error
enum_validation_error_code
error_response
factory
factory_legal_address
find_purchase_orders_billing_status
find_purchase_orders_entity_type
find_purchase_orders_extend_item
find_purchase_orders_status
generic_validation_error
get_all_customer_addresses_entity_type
get_all_inventory_movements_resource_type
get_all_inventory_point_extend_item
get_all_locations_response_200
get_all_manufacturing_order_operation_rows_status
get_all_manufacturing_order_recipe_rows_ingredient_availability
get_all_manufacturing_orders_status
get_all_materials_extend_item
get_all_product_operation_rows_response_200
get_all_product_operation_rows_response_200_data_item
get_all_products_extend_item
get_all_sales_order_addresses_entity_type
get_all_sales_order_rows_extend_item
get_all_sales_order_rows_product_availability
get_all_sales_orders_ingredient_availability
get_all_sales_orders_product_availability
get_all_sales_returns_refund_status
get_all_serial_numbers_resource_type
get_all_variants_extend_item
get_material_extend_item
get_product_extend_item
get_purchase_order_additional_cost_rows_distribution_method
get_purchase_order_extend_item
get_sales_order_returnable_items_response_200_item
get_sales_order_row_extend_item
get_sales_return_reasons_response_200_item
get_sales_return_row_unassigned_batch_transactions_response_200
get_sales_return_row_unassigned_batch_transactions_response_200_data_item
get_variant_extend_item
invalid_type_validation_error
invalid_type_validation_error_code
inventory
inventory_item
inventory_item_type
inventory_list_response
inventory_movement
inventory_movement_list_response
inventory_movement_resource_type
inventory_reorder_point
inventory_reorder_point_response
inventory_safety_stock_level
inventory_safety_stock_level_response
item_config
location_address
location_type_0
make_to_order_manufacturing_order_request
manufacturing_order
manufacturing_order_ingredient_availability_type_0
manufacturing_order_list_response
manufacturing_order_operation_production
manufacturing_order_operation_row
manufacturing_order_operation_row_list_response
manufacturing_order_operation_row_status
manufacturing_order_production
manufacturing_order_production_ingredient
manufacturing_order_production_ingredient_response
manufacturing_order_production_list_response
manufacturing_order_recipe_row
manufacturing_order_recipe_row_batch_transactions_item
manufacturing_order_recipe_row_list_response
manufacturing_order_status
material
material_config
material_list_response
material_type
max_validation_error
max_validation_error_code
min_validation_error
min_validation_error_code
negative_stock
negative_stock_list_response
operator
outsourced_purchase_order
outsourced_purchase_order_entity_type
outsourced_purchase_order_ingredient_availability
outsourced_purchase_order_recipe_row
outsourced_purchase_order_recipe_row_batch_transactions_item
outsourced_purchase_order_recipe_row_ingredient_availability
outsourced_purchase_order_recipe_row_list_response
pattern_validation_error
pattern_validation_error_code
price_list
price_list_customer
price_list_customer_list_response
price_list_list_response
price_list_row
price_list_row_adjustment_method
price_list_row_list_response
product
product_list_response
product_operation_rerank
product_operation_rerank_request
product_type
purchase_order_accounting_metadata
purchase_order_accounting_metadata_list_response
purchase_order_additional_cost_row
purchase_order_additional_cost_row_list_response
purchase_order_base
purchase_order_base_billing_status
purchase_order_base_entity_type
purchase_order_base_last_document_status
purchase_order_base_status
purchase_order_list_response
purchase_order_receive_row
purchase_order_receive_row_batch_transactions_item
purchase_order_row
purchase_order_row_batch_transactions_item
purchase_order_row_list_response
purchase_order_row_request
recipe
recipe_list_response
regular_purchase_order
regular_purchase_order_entity_type
required_validation_error
required_validation_error_code
sales_order
sales_order_accounting_metadata
sales_order_accounting_metadata_integration_type
sales_order_accounting_metadata_list_response
sales_order_address
sales_order_address_entity_type
sales_order_address_list_response
sales_order_fulfillment
sales_order_fulfillment_list_response
sales_order_ingredient_availability_type_0
sales_order_list_response
sales_order_product_availability_type_0
sales_order_production_status_type_0
sales_order_row
sales_order_row_attributes_item
sales_order_row_batch_transactions_item
sales_order_row_list_response
sales_order_row_product_availability_type_0
sales_order_shipping_fee
sales_order_shipping_fee_list_response
sales_order_status
sales_return
sales_return_list_response
sales_return_row
sales_return_row_list_response
sales_return_status
serial_number
serial_number_list_response
serial_number_resource_type
serial_number_stock
serial_number_stock_transactions_item
service
service_list_response
service_type
service_variant
service_variant_custom_fields_item
service_variant_type
stock_adjustment
stock_adjustment_batch_transaction
stock_adjustment_list_response
stock_adjustment_row
stock_adjustment_status
stock_transfer
stock_transfer_list_response
stock_transfer_row
stock_transfer_row_batch_transactions_item
stock_transfer_status
stocktake
stocktake_list_response
stocktake_row
stocktake_row_list_response
stocktake_status
stocktake_status
Table of contents
stocktake_status
storage_bin
storage_bin_list_response
storage_bin_response
storage_bin_update
supplier
supplier_address
supplier_address_list_response
supplier_address_request
supplier_list_response
tax_rate
tax_rate_list_response
too_big_validation_error
too_big_validation_error_code
too_small_validation_error
too_small_validation_error_code
unlink_manufacturing_order_request
unlink_variant_bin_location_request
unrecognized_keys_validation_error
unrecognized_keys_validation_error_code
updatable_entity
update_bom_row_request
update_customer_address_body
update_customer_address_body_entity_type
update_customer_request
update_manufacturing_order_operation_row_request
update_manufacturing_order_production_ingredient_request
update_manufacturing_order_production_request
update_manufacturing_order_recipe_row_request
update_manufacturing_order_recipe_row_request_batch_transactions_item
update_manufacturing_order_request
update_material_request
update_material_request_configs_item
update_outsourced_purchase_order_recipe_row_body
update_price_list_customer_request
update_price_list_request
update_price_list_row_request
update_product_operation_row_body
update_product_operation_row_response_200
update_product_request
update_product_request_configs_item
update_purchase_order_additional_cost_row_request
update_purchase_order_additional_cost_row_request_distribution_method
update_purchase_order_request
update_purchase_order_request_status
update_purchase_order_row_request
update_recipe_row_body
update_sales_order_address_request
update_sales_order_address_request_entity_type
update_sales_order_body
update_sales_order_body_status
update_sales_order_fulfillment_body
update_sales_order_row_request
update_sales_order_shipping_fee_body
update_sales_return_request
update_sales_return_request_status
update_sales_return_row_body
update_service_request
update_stock_adjustment_request
update_stock_adjustment_request_status
update_stock_adjustment_request_stock_adjustment_rows_item
update_stock_transfer_body
update_stock_transfer_status_body
update_stock_transfer_status_body_status
update_stocktake_request
update_stocktake_request_status
update_stocktake_row_request
update_supplier_address_request
update_supplier_request
update_variant_request
update_variant_request_config_attributes_item
update_variant_request_custom_fields_item
update_webhook_request
user
user_list_response
variant
variant_config_attributes_item
variant_custom_fields_item
variant_default_storage_bin_link
variant_default_storage_bin_link_response
variant_list_response
variant_response
variant_response_config_attributes_item
variant_response_custom_fields_item
variant_response_type
variant_type
webhook
webhook_event
webhook_event_payload
webhook_event_payload_object
webhook_list_response
webhook_logs_export
webhook_logs_export_request
webhook_logs_export_request_format
webhook_logs_export_request_status_filter_item
utils
OpenAPI Documentation
Development
Development
Contributing
uv Package Manager
Semantic Release
PyPI Setup
Release Guide
Monorepo ADRs
Monorepo ADRs
Overview
ADR-009 Migrate to uv
ADR-013 Module-Local Docs
Table of contents
stocktake_status
katana_public_api_client.models.stocktake_status
¶
katana_public_api_client.models.stocktake_status
¶
Back to top