Procedures

Automation procedures in the Katana book.

The following documentation is for Katana v1.1.0 (BDK).

Ensure that you have installed or connected the Katana book and created a new playground before using these automation procedures.

to retrieve some (customers)

FILTER - CAPABLE

Fetch the customers with optional filtering.

Output Concepts

Concept	Description	Type
customers	The retrieved customers.	katana customer

Examples

Retrieve customers

retrieve some customers

Retrieve customers with filtering

retrieve some customers whose currency is "USD"

Retrieve customers with a limit and offset

retrieve the customers
    the limit is 10
    the offset is 5

to retrieve some (purchase orders)

FILTER - CAPABLE

Fetch the purchase orders with optional filtering.

Input Concepts

Concept	Description	Type	Required	Default Value
include deleted	Whether to include deleted items in the response.	boolean	No	(no default)

Output Concepts

Concept	Description	Type
purchase orders	The retrieved purchase orders.	katana purchase order

Examples

Retrieve purchase orders

retrieve some purchase orders

Retrieve purchase orders with filtering

retrieve some purchase orders whose status is "RECEIVED"

Retrieve purchase orders for specific supplier

retrieve some purchase orders whose supplier_id is 789012

Retrieve purchase orders with a limit and offset

retrieve the purchase orders
    the limit is 10
    the offset is 3

Retrieve purchase orders with include_deleted

retrieve the purchase orders
    the include deleted is 'true'

to retrieve some (sales orders)

FILTER - CAPABLE

Fetch the sales orders with optional filtering.

Input Concepts

Concept	Description	Type	Required	Default Value
include deleted	Whether to include deleted items in the response.	boolean	No	(no default)

Output Concepts

Concept	Description	Type
sales orders	The retrieved sales orders.	katana sales order

Examples

Retrieve sales orders

retrieve some sales orders

Retrieve sales orders with filtering

retrieve some sales orders whose status is "DELIVERED"

Retrieve sales orders for specific customer

retrieve some sales orders whose customer_id is 123456

Retrieve sales orders with a limit and offset

retrieve the sales orders
    the limit is 10
    the offset is 5

Retrieve sales orders with include_deleted

retrieve the sales orders
    the include deleted is 'true'

to update a (sales order)

Update an existing sales order.

Input Concepts

Concept	Description	Type	Required	Default Value
sales order	The SalesOrder object with updated fields	katana sales order	Yes	(no default)

Output Concepts

Concept	Description	Type
sales order	The updated sales order.	katana sales order

Examples

Update sales order

...
use the above as the sales order
set the sales order's status to "PACKED"
update the sales order