# Connect Katana to Square and automate your tasks

Describe to build

Activity reports

Fully supported

MESA's Katana to Square integration is the fastest way to sync data between the two — without touching a line of code. Choose which fields to send, how they're formatted, and when the sync happens. Start with a pre-built template, customize it with AI, or build something completely unique in under 10 minutes.

[Try MESA for free](/content/pricing/index.html)

★★★★★ 4.9 rating on Shopify App Store

Start when...

Personalize with built-in tools...

Then, do this...

## Start your first automated workflow

Use pre-made workflow templates to get started quickly.

-

#### [Create Katana Sales Orders from Square Orders](/content/templates/auto-create-katana-sales-order-from-square/index.html)

[View template](/content/templates/auto-create-katana-sales-order-from-square/index.html)

Trusted by 1,000+ Shopify merchants

## Why integrate Katana with Square

The Katana to Square integration helps you sync data, automate manual tasks, and keep your stack aligned — without writing code.

[Order automation →](/content/solutions/order-automation/index.html)

### Keep Katana production orders in sync with Shopify sales

When an order is placed in Shopify, MESA creates or updates the corresponding production order in Katana. Your manufacturing queue stays current with demand without anyone manually bridging the two systems.

[Inventory management →](/content/solutions/inventory-management/index.html)

### Update Shopify inventory when Katana production is complete

When a production run finishes in Katana, MESA updates the available stock in Shopify. Your storefront reflects what's actually ready to sell without a manual sync step between your factory floor and your store.

[Data integration →](/content/solutions/data-integration/index.html)

### Log production and materials data where your ops team works

When Katana records a production event — a run started, a material consumed, a batch completed — MESA writes the details to Airtable, Google Sheets, or ClickUp. Your operations team has a running view without leaving their tools.

[Data integration →](/content/solutions/data-integration/index.html)

### Sync Square transactions into your Shopify customer records

When a purchase is made in Square — in-store, at an event, at a pop-up — MESA creates or updates the customer's record in Shopify. Your ecommerce and physical sales channels share a single view of every customer.

[Inventory management →](/content/solutions/inventory-management/index.html)

### Keep inventory accurate across Square and Shopify

When a sale is made in Square, MESA updates the corresponding stock level in Shopify. Your online storefront reflects what was just sold in person without a manual sync between your point-of-sale and your store.

[Customer experience →](/content/solutions/customer-experience/index.html)

### Trigger post-purchase workflows from Square transactions

When a customer buys in Square, MESA kicks off the right next step in Shopify — adding a tag, enrolling them in a Klaviyo flow, updating a loyalty record. Your in-person sales feed the same automation as your online ones.

## Build any Katana and Square automation

MESA helps you connect apps to automate repetitive tasks. A trigger is an event that starts a workflow, and actions are the steps that occur when it's running.

###### Catalog Item Created

Starts when a catalog item is created.

- Type

- ID

- Updated At

- Version

- Is Deleted

- Custom Attribute Values

- Catalog V1 Ids

- Present At All Locations

- Present At Location Ids

- Absent At Location Ids

- Item Data

- Category Data

- Item Variation Data

- Tax Data

- Discount Data

- Modifier List Data

- Modifier Data

- Time Period Data

- Product Set Data

- Pricing Rule Data

- Image Data

- Subscription Plan Data

- Item Option Data

- Item Option Value Data

- Custom Attribute Definition Data

- Subscription Plan Variation Data

###### Catalog Item Updated

Starts when a catalog item is updated.

- Type

- ID

- Updated At

- Version

- Is Deleted

- Custom Attribute Values

- Catalog V1 Ids

- Present At All Locations

- Present At Location Ids

- Absent At Location Ids

- Item Data

- Category Data

- Item Variation Data

- Tax Data

- Discount Data

- Modifier List Data

- Modifier Data

- Time Period Data

- Product Set Data

- Pricing Rule Data

- Image Data

- Subscription Plan Data

- Item Option Data

- Item Option Value Data

- Custom Attribute Definition Data

- Subscription Plan Variation Data

###### Customer Created

Starts when a customer is created.

- ID

- Created At

- Updated At

- Given Name

- Family Name

- Nickname

- Company Name

- Email Address

- Address

- Phone Number

- Birthday

- Reference ID

- Note

- Preferences

- Creation Source

- Group Ids

- Segment Ids

- Version

- Tax Ids

###### Customer Updated

Starts when a customer is updated.

- ID

- Created At

- Updated At

- Given Name

- Family Name

- Nickname

- Company Name

- Email Address

- Address

- Phone Number

- Birthday

- Reference ID

- Note

- Preferences

- Creation Source

- Group Ids

- Segment Ids

- Version

- Tax Ids

###### Invoice Added

Starts when an invoice is added.

- ID

- Version

- Location ID

- Order ID

- Primary Recipient

- Payment Requests

- Delivery Method

- Invoice Number

- Title

- Description

- Scheduled At

- Public URL

- Next Payment Amount Money

- Status

- Timezone

- Created At

- Updated At

- Accepted Payment Methods

- Custom Fields

- Subscription ID

- Sale Or Service Date

- Payment Conditions

- Store Payment Method Enabled

- Attachments

- Creator Team Member ID

###### Order Created

Starts when an order is created.

- ID

- Location ID

- Reference ID

- Source

- Line Items

- Taxes

- Discounts

- Service Charges

- Fulfillments

- Created At

- Updated At

- Closed At

- State

- Total Money

- Total Tax Money

- Total Discount Money

- Total Tip Money

- Total Service Charge Money

- Pricing Options

- Net Amount Due Money

###### Order Updated

Starts when an order is updated.

- ID

- Location ID

- Reference ID

- Source

- Line Items

- Taxes

- Discounts

- Service Charges

- Fulfillments

- Created At

- Updated At

- Closed At

- State

- Total Money

- Total Tax Money

- Total Discount Money

- Total Tip Money

- Total Service Charge Money

- Pricing Options

- Net Amount Due Money

###### Payment Created

Starts when a payment is created.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Payment Updated

Starts when a payment is updated.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Payout Created

Starts when a payout from the default location (associated with the seller) is created.

- ID

- Status

- Location ID

- Created At

- Updated At

- Amount Money

- Destination

- Version

- Type

- Payout Fee

- Arrival Date

- End To End ID

###### Refund Created

Starts when a refund is created.

- ID

- Location ID

- Transaction ID

- Tender ID

- Created At

- Reason

- Amount Money

- Status

- Processing Fee Money

###### Refund Updated

Starts when a refund is updated.

- ID

- Location ID

- Transaction ID

- Tender ID

- Created At

- Reason

- Amount Money

- Status

- Processing Fee Money

###### Current Inventory Material Out of Stock

Starts when a material's current stock level is below the optimal level (quantity\_missing\_or\_excess <= 0).

###### Current Inventory Material Updated

Starts when a material's current stock level or average cost is updated.

###### Current Inventory Product Out of Stock

Starts when a product's current stock level is below the optimal level (quantity\_missing\_or\_excess <= 0).

###### Current Inventory Product Updated

Starts when a product's current stock level or average cost is updated.

###### Product Created

Starts when a product is created.

###### Product Deleted

Starts when a product is deleted.

###### Product Updated

Starts when a product is updated.

###### Sales Order Availability Updated

Starts when availability or expected date is updated for products or ingredients.

###### Sales Order Created

Starts when a sales order is created.

###### Sales Order Deleted

Starts when a sales order is deleted.

###### Sales Order Delivered

Starts when a new sales order's status is marked as delivered.

###### Sales Order Packed

Starts when a new sales order's status is marked as packed.

###### Sales Order Updated

Starts when a sales order is updated.

###### Accept Dispute

Accept the loss on a dispute.

- ID

- Amount Money

- Reason

- State

- Due At

- Disputed Payment

- Card Brand

- Created At

- Updated At

- Brand Dispute ID

- Reported At

- Version

- Location ID

###### Accumulate Loyalty Points

Add points earned from a purchase to a loyalty account.

- ID

- Type

- Created At

- Accumulate Points

- Create Reward

- Redeem Reward

- Delete Reward

- Adjust Points

- Loyalty Account ID

- Location ID

- Source

- Expire Points

- Other Event

- Accumulate Promotion Points

###### Add Group to Customer

Add a group membership to a customer.

###### Adjust Loyalty Points

Add points to or subtract points from a buyer's account.

###### Calculate Loyalty Points

Calculate the number of points a buyer can earn from a purchase.

- Points

- Promotion Points

###### Calculate Order

Enables applications to preview order pricing without creating an order.

###### Cancel Booking

Cancel a booking.

- ID

- Version

- Status

- Created At

- Updated At

- Start At

- Location ID

- Customer ID

- Customer Note

- Seller Note

- Appointment Segments

- Transition Time Minutes

- All Day

- Location Type

- Creator Details

- Source

- Address

###### Cancel Payment

Cancel a payment.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Cancel Subscription

Cancel a subscription.

- ID

- Location ID

- Plan Variation ID

- Customer ID

- Start Date

- Canceled Date

- Charged Through Date

- Status

- Tax Percentage

- Invoice Ids

- Price Override Money

- Version

- Created At

- Card ID

- Timezone

- Phases

###### Cancel Terminal Checkout

Cancel a terminal checkout.

- ID

- Amount Money

- Reference ID

- Note

- Order ID

- Payment Options

- Device Options

- Status

- Cancel Reason

- Payment Ids

- Created At

- Updated At

- App ID

- Location ID

- Payment Type

- Team Member ID

- Customer ID

- App Fee Money

- Statement Description Identifier

- Tip Money

###### Complete Payment

Complete a payment.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Create Booking

Create a booking.

- Idempotency Key

- Booking

###### Create Break Type

Create a new break type.

- Idempotency Key

- Break Type

###### Create Card

Add a card on file to an existing merchant.

- Idempotency Key

- Source ID

- Verification Token

- Card

###### Create Checkout

Create a checkout.

- Idempotency Key

- Order

- Ask For Shipping Address

- Merchant Support Email

- Pre Populate Buyer Email

- Pre Populate Shipping Address

- Redirect URL

- Additional Recipients

- Note

###### Create Customer

Create a new customer for the business, which can have associated cards on file.

- Idempotency Key

- Given Name

- Family Name

- Company Name

- Nickname

- Email Address

- Address

- Phone Number

- Reference ID

- Note

- Birthday

- Tax Ids

###### Create Customer Card

Add a card on file to an existing customer.

###### Create Customer Group

Create a customer group.

###### Create Dispute Evidence File

Upload a file to use as evidence in a dispute challenge.

###### Create Dispute Evidence Text

Upload text to use as evidence for a dispute challenge.

- Idempotency Key

- Evidence Type

- Evidence Text

###### Create Gift Card

Create a gift card.

- Idempotency Key

- Location ID

- Gift Card

###### Create Gift Card Activity

Create a gift card activity to manage the balance or state of a gift card.

- Idempotency Key

- Gift Card Activity

###### Create Invoice

Create an invoice.

- Invoice

- Idempotency Key

###### Create Location

Create a location.

###### Create Location Transaction

Create a location transaction.

###### Create Loyalty Account

Create a loyalty account.

###### Create Loyalty Rewards

Create a loyalty reward.

- Reward

- Idempotency Key

###### Create Order Shipment

Create an order shipment.

###### Create Payment

Create a payment.

- Source ID

- Idempotency Key

- Amount Money

- Tip Money

- App Fee Money

- Delay Duration

- Delay Action

- Autocomplete

- Order ID

- Customer ID

- Location ID

- Team Member ID

- Reference ID

- Verification Token

- Accept Partial Authorization

- Buyer Email Address

- Buyer Phone Number

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Cash Details

- External Details

- Customer Details

- Offline Payment Details

###### Create Refund

Initiates a refund for a previously charged tender.

###### Create Shift

Create a new shift.

###### Create Subscription

Create a subscription.

- Idempotency Key

- Location ID

- Plan Variation ID

- Customer ID

- Start Date

- Canceled Date

- Tax Percentage

- Price Override Money

- Card ID

- Timezone

- Phases

###### Create Team Member

Create a team member.

- Idempotency Key

- Team Member

###### Create Terminal Checkout

Create a terminal checkout.

- Idempotency Key

- Checkout

###### Delete Break Type

Remove a break type.

###### Delete Catalog Object

Remove a catalog object.

- 0

###### Delete Customer

Remove a customer.

###### Delete Customer Card

Remove a card on file from a customer.

###### Delete Customer Group

Remove a customer group.

###### Delete Dispute

Remove a specified evidence from a dispute.

###### Delete Group from Customer

Remove a customer from a business.

###### Delete Invoice

Remove an invoice.

###### Delete Loyalty Reward

Remove a loyalty reward.

###### Delete Shift

Remove a shift.

###### Disable Card

Disable a card, preventing any further updates or changes.

###### Get List of Additional Recipient Receivables

Obtain a list of additional recipient receivables.

###### Get List of Additional Recipient Receivables Refunds

Obtain a list of additional recipient receivables refunds.

###### Get List of Bank Accounts

Obtain a list of bank accounts linked to a Square account.

- ID

- Account Number Suffix

- Country

- Currency

- Account Type

- Holder Name

- Primary Bank Identification Number

- Secondary Bank Identification Number

- Debit Mandate Reference ID

- Reference ID

- Location ID

- Status

- Creditable

- Debitable

- Fingerprint

- Version

- Bank Name

###### Get List of Cards

Obtain a list of cards owned by the account.

- ID

- Card Brand

- Last 4

- Exp Month

- Exp Year

- Cardholder Name

- Billing Address

- Fingerprint

- Customer ID

- Merchant ID

- Reference ID

- Enabled

- Card Type

- Prepaid Type

- Bin

- Version

- Card Co Brand

###### Get List of Catalog

Obtain a list of catalog objects.

- Cursor

- Objects

###### Get List of Customer Groups

Obtain a list of customer groups.

- ID

- Name

- Created At

- Updated At

###### Get List of Customer Segments

Obtain a list of customer segments.

- ID

- Name

- Created At

- Updated At

###### Get List of Customers

Obtain a list of customers.

- ID

- Created At

- Updated At

- Given Name

- Family Name

- Nickname

- Company Name

- Email Address

- Address

- Phone Number

- Birthday

- Reference ID

- Note

- Preferences

- Creation Source

- Group Ids

- Segment Ids

- Version

- Tax Ids

###### Get List of Dispute Evidence

Obtain a list of evidence associated with a dispute.

- ID

- Dispute ID

- Evidence File

- Evidence Text

- Uploaded At

- Evidence Type

###### Get List of Disputes

Obtain a list of disputes.

- ID

- Amount Money

- Reason

- State

- Due At

- Disputed Payment

- Card Brand

- Created At

- Updated At

- Brand Dispute ID

- Reported At

- Version

- Location ID

###### Get List of Employee Wages

Obtain a list of employee wages.

###### Get List of Employees

Obtain a list of employees.

###### Get List of Invoices

Obtain a list of invoices.

- ID

- Version

- Location ID

- Order ID

- Primary Recipient

- Payment Requests

- Delivery Method

- Invoice Number

- Title

- Description

- Scheduled At

- Public URL

- Next Payment Amount Money

- Status

- Timezone

- Created At

- Updated At

- Accepted Payment Methods

- Custom Fields

- Subscription ID

- Sale Or Service Date

- Payment Conditions

- Store Payment Method Enabled

- Attachments

- Creator Team Member ID

###### Get List of Locations

Obtain a list of all of a seller's locations.

- ID

- Name

- Address

- Timezone

- Capabilities

- Status

- Created At

- Merchant ID

- Country

- Language Code

- Currency

- Phone Number

- Business Name

- Type

- Website URL

- Business Hours

- Business Email

- Description

- Twitter Username

- Instagram Username

- Facebook URL

- Coordinates

- Logo URL

- Pos Background URL

- Full Format Logo URL

###### Get List of Loyalty Programs

Obtain a list of loyalty programs.

###### Get List of Merchants

Obtain a list of merchants.

###### Get List of Payment Refunds

Obtain a list of payment refunds.

- ID

- Status

- Location ID

- Unlinked

- Destination Type

- Destination Details

- Amount Money

- App Fee Money

- Processing Fee

- Payment ID

- Order ID

- Reason

- Created At

- Updated At

- Team Member ID

###### Get List of Payments

Obtain a list of payments.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Get List of Refunds

Obtain a list of refunds.

###### Get List of Sites

Obtain a list of Square Online sites that belong to a seller.

###### Get List of Subscription Events

Obtain a list of subscription events.

- ID

- Subscription Event Type

- Effective Date

- Info

- Phases

- Plan Variation ID

###### Get List of Team Member Booking Profiles

Obtain a list of booking profiles for team members.

###### Get List of Team Member Wages

Obtain a list of team member wages.

###### Get List of Transactions

Obtain a list of transactions for a particular location.

###### Get List of Workweek Configs

Obtain a list of workweek configs instances for a business.

###### Link Customer to Gift Card

Link a customer to a gift card, which is also referred to as adding a card on file.

- ID

- Type

- Gan Source

- State

- Balance Money

- Gan

- Created At

- Customer Ids

###### List Break Type

Get list of all break types

- ID

- Location ID

- Break Name

- Expected Duration

- Is Paid

- Version

- Created At

- Updated At

###### Pay Order

Pay for an order using one or more approved payments or settle an order with a total of 0.

###### Publish Invoice

Publish the specified draft invoice.

###### Redeem Loyalty Rewards

Redeem a loyalty reward.

###### Refund Payment

Refund a payment.

- ID

- Status

- Location ID

- Unlinked

- Destination Type

- Destination Details

- Amount Money

- App Fee Money

- Processing Fee

- Payment ID

- Order ID

- Reason

- Created At

- Updated At

- Team Member ID

###### Register Domain

Activates a domain for us with Apple Pay on the Web and Square.

- Status

###### Retrieve Bank Account

Grab all details about a bank account.

- ID

- Account Number Suffix

- Country

- Currency

- Account Type

- Holder Name

- Primary Bank Identification Number

- Secondary Bank Identification Number

- Debit Mandate Reference ID

- Reference ID

- Location ID

- Status

- Creditable

- Debitable

- Fingerprint

- Version

- Bank Name

###### Retrieve Bank Account by V1 ID

Grab all details about a bank account by V1 bank account id.

###### Retrieve Booking

Grab all details about a booking.

###### Retrieve Break Type

Grab all details about a break type.

- ID

- Location ID

- Break Name

- Expected Duration

- Is Paid

- Version

- Created At

- Updated At

###### Retrieve Card

Grab all details about a card.

- ID

- Card Brand

- Last 4

- Exp Month

- Exp Year

- Cardholder Name

- Billing Address

- Fingerprint

- Customer ID

- Merchant ID

- Reference ID

- Enabled

- Card Type

- Prepaid Type

- Bin

- Version

- Card Co Brand

###### Retrieve Catalog Object

Grab all details about a catalog object.

- Type

- ID

- Updated At

- Version

- Is Deleted

- Custom Attribute Values

- Catalog V1 Ids

- Present At All Locations

- Present At Location Ids

- Absent At Location Ids

- Item Data

- Category Data

- Item Variation Data

- Tax Data

- Discount Data

- Modifier List Data

- Modifier Data

- Time Period Data

- Product Set Data

- Pricing Rule Data

- Image Data

- Subscription Plan Data

- Item Option Data

- Item Option Value Data

- Custom Attribute Definition Data

- Subscription Plan Variation Data

###### Retrieve Customer

Grab all details about a customer.

- ID

- Created At

- Updated At

- Given Name

- Family Name

- Nickname

- Company Name

- Email Address

- Address

- Phone Number

- Birthday

- Reference ID

- Note

- Preferences

- Creation Source

- Group Ids

- Segment Ids

- Version

- Tax Ids

###### Retrieve Customer Group

Grab all details about a customer group.

###### Retrieve Customer Segments

Grab all details about a customer segment.

###### Retrieve Dispute

Grab all details about a dispute.

- ID

- Amount Money

- Reason

- State

- Due At

- Disputed Payment

- Card Brand

- Created At

- Updated At

- Brand Dispute ID

- Reported At

- Version

- Location ID

###### Retrieve Dispute Evidence

Grab all details about a dispute evidence.

- ID

- Dispute ID

- Evidence File

- Evidence Text

- Uploaded At

- Evidence Type

###### Retrieve Employee

Grab all details about an employee.

###### Retrieve Employee Wage

Grab all details about an employee's wage.

###### Retrieve Gift Card

Grab all details about a gift card.

###### Retrieve Inventory Adjustment

Grab all details about an inventory adjustment.

###### Retrieve Inventory Changes

Grab all details about an inventory change.

###### Retrieve Inventory Count

Grab the inventory count for a given catalog.

- Catalog Object ID

- Catalog Object Type

- State

- Location ID

- Quantity

- Calculated At

###### Retrieve Inventory Physical Count

Grab the inventory physical count.

###### Retrieve Invoice

Grab all details about an invoice

- ID

- Version

- Location ID

- Order ID

- Primary Recipient

- Payment Requests

- Delivery Method

- Invoice Number

- Title

- Description

- Scheduled At

- Public URL

- Next Payment Amount Money

- Status

- Timezone

- Created At

- Updated At

- Accepted Payment Methods

- Custom Fields

- Subscription ID

- Sale Or Service Date

- Payment Conditions

- Store Payment Method Enabled

- Attachments

- Creator Team Member ID

###### Retrieve Location

Grab all details about a location's details.

###### Retrieve Loyalty Account

Grab all details about a loyalty account.

- ID

- Program ID

- Balance

- Lifetime Points

- Customer ID

- Enrolled At

- Created At

- Updated At

- Mapping

- Expiring Point Deadlines

###### Retrieve Loyalty Reward

Grab all details about a loyalty reward.

- ID

- Status

- Loyalty Account ID

- Reward Tier ID

- Points

- Order ID

- Created At

- Updated At

- Redeemed At

###### Retrieve Merchant

Grab all details about a merchant.

- ID

- Business Name

- Country

- Language Code

- Currency

- Status

- Main Location ID

- Created At

###### Retrieve Order

Grab all details about an order.

- ID

- Location ID

- Reference ID

- Source

- Line Items

- Taxes

- Discounts

- Service Charges

- Fulfillments

- Created At

- Updated At

- Closed At

- State

- Total Money

- Total Tax Money

- Total Discount Money

- Total Tip Money

- Total Service Charge Money

- Pricing Options

- Net Amount Due Money

###### Retrieve Payment

Grab all details about a payment.

- ID

- Created At

- Updated At

- Amount Money

- Tip Money

- Total Money

- App Fee Money

- Approved Money

- Processing Fee

- Refunded Money

- Status

- Delay Duration

- Delay Action

- Delayed Until

- Source Type

- Card Details

- Cash Details

- Bank Account Details

- External Details

- Wallet Details

- Buy Now Pay Later Details

- Square Account Details

- Location ID

- Order ID

- Reference ID

- Customer ID

- Team Member ID

- Refund Ids

- Buyer Email Address

- Billing Address

- Shipping Address

- Note

- Statement Description Identifier

- Capabilities

- Receipt Number

- Receipt URL

- Device Details

- Application Details

- Is Offline Payment

- Offline Payment Details

- Version Token

###### Retrieve Payment Refund

Grab all details about a payment refund.

- ID

- Status

- Location ID

- Unlinked

- Destination Type

- Destination Details

- Amount Money

- App Fee Money

- Processing Fee

- Payment ID

- Order ID

- Reason

- Created At

- Updated At

- Team Member ID

###### Retrieve Shift

Grab all details about a shift.

###### Retrieve Subscription

Grab all details about a subscription.

- ID

- Location ID

- Plan Variation ID

- Customer ID

- Start Date

- Canceled Date

- Charged Through Date

- Status

- Tax Percentage

- Invoice Ids

- Price Override Money

- Version

- Created At

- Card ID

- Timezone

- Phases

###### Retrieve Team Member

Grab all details about a team member.

- ID

- Reference ID

- Is Owner

- Status

- Given Name

- Family Name

- Email Address

- Phone Number

- Created At

- Updated At

- Assigned Locations

###### Retrieve Terminal Checkout

Grab all details about a terminal checkout.

- ID

- Amount Money

- Reference ID

- Note

- Order ID

- Payment Options

- Device Options

- Status

- Cancel Reason

- Payment Ids

- Created At

- Updated At

- App ID

- Location ID

- Payment Type

- Team Member ID

- Customer ID

- App Fee Money

- Statement Description Identifier

- Tip Money

###### Retrieve Transaction

Grab all details about a transaction.

###### Retrieve Wage Setting

Grab all details about a wage setting.

###### Search Availability

Search availabilities for booking.

- Start At

- Location ID

- Appointment Segments

###### Search Catalog

Search for a catalog.

- Cursor

- Objects

- Related Objects

###### Search Customer

Search for a customer.

- ID

- Created At

- Updated At

- Given Name

- Family Name

- Nickname

- Company Name

- Email Address

- Address

- Phone Number

- Birthday

- Reference ID

- Note

- Preferences

- Creation Source

- Group Ids

- Segment Ids

- Version

- Tax Ids

###### Search for Catalog Item

Search for a catalog item.

###### Search Invoice

Search for an invoice.

###### Search Loyalty Account

Search for a loyalty account.

- ID

- Program ID

- Balance

- Lifetime Points

- Customer ID

- Enrolled At

- Created At

- Updated At

- Mapping

- Expiring Point Deadlines

###### Search Loyalty Event

Search for a loyalty event.

- ID

- Type

- Created At

- Accumulate Points

- Create Reward

- Redeem Reward

- Delete Reward

- Adjust Points

- Loyalty Account ID

- Location ID

- Source

- Expire Points

- Other Event

- Accumulate Promotion Points

###### Search Loyalty Rewards

Search for a loyalty reward.

- ID

- Status

- Loyalty Account ID

- Reward Tier ID

- Points

- Order ID

- Created At

- Updated At

- Redeemed At

###### Search Shifts

Search for a shift.

###### Search Subscription

Search for a subscription.

###### Search Team Members

Search for a team member.

- ID

- Reference ID

- Is Owner

- Status

- Given Name

- Family Name

- Email Address

- Phone Number

- Created At

- Updated At

- Assigned Locations

###### Search Terminal Checkout

Search for a terminal checkout.

###### Searchorders /V2/Orders/Search

SearchOrders

###### Submit Evidence

Submit evidence to the cardholder's bank.

- ID

- Amount Money

- Reason

- State

- Due At

- Disputed Payment

- Card Brand

- Created At

- Updated At

- Brand Dispute ID

- Reported At

- Version

- Location ID

###### Update Booking

Modify a booking's details.

- Idempotency Key

- Booking

###### Update Break Type

Modify a break type's details.

- Break Type

###### Update Customer

Modify a customer's details.

- Given Name

- Family Name

- Company Name

- Nickname

- Email Address

- Address

- Phone Number

- Reference ID

- Note

- Birthday

- Version

- Tax Ids

###### Update Customer Group

Modify a customer group.

###### Update Inventory

Modify inventory for an item.

- Idempotency Key

- Changes

- Ignore Unchanged Counts

###### Update Invoice

Modify an invoice's details.

- Invoice

- Idempotency Key

- Fields To Clear

###### Update Item Modifier Lists

Modify a catalog modifier list object that apply to the targeted catalog item.

###### Update Item Taxes

Modify a catalog tax object that apply to the targeted catalog item.

###### Update Location

Modify a location's details.

###### Update Order Fulfillment

Modify an order fulfillment's details.

###### Update Shift

Modify a shift's details.

###### Update Subscription

Modify a subscription's details.

- Subscription

###### Update Team Member

Modify a team member's details.

- Team Member

###### Update Wage Setting

Modify a wage setting's details.

###### Update Workweek Config

Modify a workweek's config details.

###### Void Transaction

Cancel a transaction.

###### Assign Serial Numbers to Resource

Assign serial numbers to a resource.

- ID

- Transaction ID

- Serial Number

- Resource Type

- Resource ID

- Transaction Date

- Quantity Change

###### Change Product Operation's Rank

Modify the product operations's rank.

###### Create Customer

Create a customer.

- Name

- First Name

- Last Name

- Company

- Email

- Phone

- Currency

- Reference ID

- Comment

- Discount Rate

- Addresses

###### Create Customer Address

Add an address to an existing customer. A customer can have one billing address and multiple shipping addresses. If the new address is the first of its type, it is assigned as the default.

- Customer ID

- Entity Type

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Create Make-to-Order Manufacturing Order

Create a manufacturing order that is linked to a specific sales order row.

- Sales Order Row ID

- Create Subassemblies

###### Create Manufacturing Order

Create a manufacturing order. Manufacturing order recipe and operation rows are created automatically based on the product recipe and operations.

- Status

- Order No

- Variant ID

- Location ID

- Planned Quantity

- Actual Quantity

- Order Created Date

- Production Deadline Date

- Additional Info

- Batch Transactions

###### Create Manufacturing Order Operation Row

Add an operation row to an existing manufacturing order. Operation rows cannot be added when the manufacturing order status is DONE.

- Manufacturing Order ID

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Planned Time Per Unit

- Cost Per Hour

- Status

- Assigned Operators

###### Create Manufacturing Order Production

Create a manufacturing order production.

- Manufacturing Order ID

- Completed Quantity

- Completed Date

- Is Final

- Ingredients

- Operations

- Serial Numbers

###### Create Manufacturing Order Recipe Row

Add a recipe row to an existing manufacturing order. Recipe rows cannot be added when the manufacturing order status is DONE.

- Manufacturing Order ID

- Variant ID

- Notes

- Planned Quantity Per Unit

- Total Actual Quantity

- Batch Transactions

###### Create Material

Create a material.

- Name

- Uom

- Category Name

- Default Supplier ID

- Additional Info

- Batch Tracked

- Purchase Uom

- Purchase Uom Conversion Rate

- Configs

- Variants

###### Create Outsourced Purchase Order Recipe Row

Add a recipe row to an existing outsourced purchase order. Recipe rows cannot be added when the order status is RECEIVED.

- Purchase Order Row ID

- Ingredient Variant ID

- Planned Quantity Per Unit

- Notes

- Batch Transactions

###### Create Product

Create a product.

- Name

- Uom

- Category Name

- Is Producible

- Is Purchasable

- Default Supplier ID

- Additional Info

- Batch Tracked

- Serial Tracked

- Operations In Sequence

- Purchase Uom

- Purchase Uom Conversion Rate

- Configs

- Custom Field Collection ID

- Variants

###### Create Product Operations

Create one or many new product operation rows for a product.

- Keep Current Rows

- Rows

###### Create Purchase Order

Create a purchase order. /purchase\_orders

- Order No

- Entity Type

- Supplier ID

- Currency

- Status

- Expected Arrival Date

- Order Created Date

- Location ID

- Tracking Location ID

- Additional Info

- Purchase Order Rows

###### Create Purchase Order Additional Cost Row

Add a purchase order additional cost row to an existing group.

- Additional Cost ID

- Group ID

- Tax Rate ID

- Price

- Distribution Method

###### Create Purchase Order Row

Create a purchase order row.

- Purchase Order ID

- Quantity

- Variant ID

- Tax Rate ID

- Group ID

- Price Per Unit

- Purchase Uom Conversion Rate

- Purchase Uom

###### Create Recipes

Create a recipe.

- Keep Current Rows

- Rows

###### Create Sales Order

Create a sales order.

- Order No

- Customer ID

- Sales Order Rows

- Tracking Number

- Tracking Number URL

- Addresses

- Order Created Date

- Delivery Date

- Currency

- Location ID

- Status

- Additional Info

- Customer Ref

- Ecommerce Order Type

- Ecommerce Store Name

- Ecommerce Order ID

###### Create Sales Order Address

Create a new sales order address.

- Sales Order ID

- Entity Type

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Create Sales Order Fulfillment

Create a sales order fulfillment.

- Sales Order ID

- Picked Date

- Status

- Conversion Rate

- Conversion Date

- Tracking Number

- Tracking URL

- Tracking Carrier

- Tracking Method

- Sales Order Fulfillment Rows

###### Create Sales Order Row

Create a sales order row.

- Sales Order ID

- Quantity

- Variant ID

- Tax Rate ID

- Attributes

- Price Per Unit

- Total Discount

###### Create Sales Order Shipping Fee & Add it to Sales Order

Create a sales order shipping fee and add it to sales order.

- Sales Order ID

- Description

- Amount

- Tax Rate ID

###### Create Stock Adjustment

Create a stock adjustment.

- Stock Adjustment Number

- Stock Adjustment Date

- Location ID

- Reason

- Additional Info

- Stock Adjustment Rows

###### Create Stock Transfer

Create a stock transfer.

- Stock Transfer Number

- Source Location ID

- Target Location ID

- Transfer Date

- Additional Info

- Stock Transfer Rows

###### Create Stocktake

Create a stocktake.

- Stocktake Number

- Location ID

- Reason

- Additional Info

- Created Date

- Set Remaining Items As Counted

- Stocktake Rows

###### Create Stocktake Row

Add one or many new rows for a stocktake.

- Stocktake ID

- Stocktake Rows

###### Create Supplier

Create a supplier.

- Name

- Currency

- Email

- Phone

- Comment

- Addresses

###### Create Supplier Address

Create a supplier address.

- Supplier ID

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Create Tax Rate

Create a tax rate.

- Name

- Rate

###### Create Variant

Create a variant.

- Sku

- Sales Price

- Purchase Price

- Product ID

- Supplier Item Codes

- Internal Barcode

- Registered Barcode

- Material ID

- Config Attributes

- Custom Fields

###### Delete Customer

Remove a customer.

###### Delete Customer Address

Remove a customer's address.

###### Delete Manufacturing Order

Remove a manufacturing order.

###### Delete Manufacturing Order Operation Row

Remove a manufacturing order operation row.

###### Delete Manufacturing Order Production

Remove a manufacturing order production.

###### Delete Manufacturing Order Recipe Row

Remove a manufacturing order recipe row.

###### Delete Material

Remove a material.

###### Delete Outsourced Purchase Order Recipe Row

Remove an outsourced purchase order recipe row.

###### Delete Product

Remove a product.

###### Delete Product Operation Row

Remove a product operation row.

###### Delete Purchase Order

Remove a purchase order.

###### Delete Purchase Order Additional Cost Row

Remove a purchase order additional cost row.

###### Delete Purchase Order Row

Remove a purchase order row.

###### Delete Recipe

Remove a recipe.

###### Delete Recipe Row

Remove a recipe row.

###### Delete Sales Order

Remove a sales order.

###### Delete Sales Order Address

Remove a sales order address.

###### Delete Sales Order Fulfillment

Remove a sales order fulfillment.

###### Delete Sales Order Row

Remove a sales order row.

###### Delete Stock Adjustment

Remove a stock adjustment.

###### Delete Stock Transfer

Remove a stock transfer.

###### Delete Stocktake

Remove a stocktake.

###### Delete Stocktake Row

Remove a stocktake row.

###### Delete Storage Bin

Remove a storage bin.

###### Delete Supplier

Remove a supplier.

###### Delete Supplier Address

Remove a supplier address.

###### Delete Variant

Remove a variant.

###### Deletes Shipping Fee & Remove from Attached Sales Order

Remove shipping fee and remove it from the attached sales order.

###### Get List of Current Inventory

Obtain a list for current inventory.

- Variant ID

- Location ID

- Reorder Point

- Average Cost

- Value In Stock

- Quantity In Stock

- Quantity Committed

- Quantity Expected

- Quantity Missing Or Excess

###### Get List of Custom Fields Collections

Obtain a list of custom fields collections.

- ID

- Name

- Updated At

- Created At

- Deleted At

###### Get List of Customer Addresses

Obtain a list of customer addresses you’ve previously created. The customer addresses are returned in sorted order, with the most recent customer addresses appearing first.

- ID

- Customer ID

- Entity Type

- Default

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

- Created At

- Updated At

###### Get List of Customers

Obtain a list of all customers.

- ID

- Name

- First Name

- Last Name

- Company

- Email

- Phone

- Comment

- Currency

- Reference ID

- Discount Rate

- Created At

- Updated At

- Default Billing ID

- Default Shipping ID

- Addresses

###### Get List of Inventory Movements

Grab a list of inventory movements created by your Katana resources.

- ID

- Variant ID

- Location ID

- Resource Type

- Resource ID

- Caused By Order No

- Caused By Resource ID

- Movement Date

- Quantity Change

- Balance After

- Value Per Unit

- Value In Stock After

- Average Cost After

- Rank

- Created At

- Updated At

###### Get List of Locations

Obtain a list of locations.

- ID

- Name

- Legal Name

- Address ID

- Address

- Is Primary

- Sales Allowed

- Manufacturing Allowed

- Purchase Allowed

- Created At

- Updated At

- Deleted At

###### Get List of Manufacturing Order Operation Rows

Obtain a list of manufacturing order operation rows.

- ID

- Status

- Rank

- Manufacturing Order ID

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Assigned Operators

- Completed By Operators

- Active Operator ID

- Planned Time Per Unit

- Total Actual Time

- Planned Cost Per Unit

- Total Actual Cost

- Cost Per Hour

- Group Boundary

- Is Status Actionable

- Completed At

- Created At

- Updated At

- Deleted At

###### Get List of Manufacturing Order Recipe Rows

Obtain a list of manufacturing order recipe rows.

- ID

- Manufacturing Order ID

- Variant ID

- Notes

- Planned Quantity Per Unit

- Total Actual Quantity

- Ingredient Availability

- Ingredient Expected Date

- Batch Transactions

- Cost

- Created At

- Updated At

- Deleted At

###### Get List of Manufacturing Orders

Obtain a list of manufacturing orders.

- ID

- Status

- Order No

- Variant ID

- Planned Quantity

- Actual Quantity

- Batch Transactions

- Location ID

- Order Created Date

- Done Date

- Production Deadline Date

- Additional Info

- Is Linked To Sales Order

- Sales Order ID

- Sales Order Row ID

- Sales Order Delivery Deadline

- Ingredient Availability

- Total Cost

- Total Planned Time

- Total Actual Time

- Material Cost

- Subassemblies Cost

- Operations Cost

- Created At

- Updated At

- Deleted At

- Serial Numbers

###### Get List of Manufacturing Orders

Obtain a list of manufacturing orders.

- ID

- Manufacturing Order ID

- Quantity

- Production Date

- Created At

- Updated At

- Deleted At

- Ingredients

- Operations

- Serial Numbers

###### Get List of Materials

Obtain a list of materials.

- ID

- Name

- Uom

- Category Name

- Default Supplier ID

- Type

- Additional Info

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Tracked

- Variants

- Created At

- Updated At

- Configs

###### Get List of Operators

Obtain a list of operators.

- ID

- Operator Name

###### Get List of Outsourced Purchase Order Recipe Rows

Obtain a list of outsourced purchase order recipe rows.

- ID

- Purchase Order ID

- Purchase Order Row ID

- Ingredient Variant ID

- Planned Quantity Per Unit

- Ingredient Availability

- Ingredient Expected Date

- Notes

- Batch Transactions

- Cost

- Created At

- Updated At

- Deleted At

###### Get List of Product Operations

Obtain a list of product operations.

- Product Operation Row ID

- Product ID

- Product Variant ID

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Cost Per Hour

- Planned Time Per Unit

- Planned Cost Per Unit

- Rank

- Group Boundary

- Created At

- Updated At

###### Get List of Products

Obtain a list of products.

- ID

- Name

- Uom

- Category Name

- Is Producible

- Default Supplier ID

- Is Purchasable

- Type

- Additional Info

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Tracked

- Serial Tracked

- Operations In Sequence

- Variants

- Created At

- Updated At

- Configs

###### Get List of Purchase Order Accounting Metadata

Obtain a list of purchase order accounting metadata entries.

- ID

- Integration Type

- Bill ID

- Created At

- Purchase Order ID

- Received Items Group ID

###### Get List of Purchase Order Additional Cost Rows

Obtain list of purchase order additional cost rows you’ve previously created.

- ID

- Additional Cost ID

- Group ID

- Name

- Distribution Method

- Tax Rate ID

- Tax Rate

- Price

- Price In Base

- Currency

- Currency Conversion Rate

- Currency Conversion Rate Fix Date

- Updated At

- Created At

- Deleted At

###### Get List of Purchase Order Rows

Obtain a list of purchase order rows.

- ID

- Quantity

- Variant ID

- Tax Rate ID

- Price Per Unit

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Transactions

- Total

- Total In Base Currency

- Conversion Rate

- Conversion Date

- Received Date

- Created At

- Updated At

###### Get List of Purchase Orders

Obtain a list of purchase orders.

- ID

- Status

- Billing Status

- Last Document Status

- Order No

- Entity Type

- Supplier ID

- Currency

- Expected Arrival Date

- Order Created Date

- Additional Info

- Location ID

- Ingredient Availability

- Ingredient Expected Date

- Tracking Location ID

- Total

- Total In Base Currency

- Purchase Order Rows

- Created At

- Updated At

###### Get List of Recipes

Obtain a list of recipes.

- Recipe ID

- Recipe Row ID

- Product ID

- Product Variant ID

- Ingredient Variant ID

- Quantity

- Notes

- Created At

- Updated At

###### Get List of Sales Order Accounting Metadata

Obtain a list of sales order accounting metadata.

###### Get List of Sales Order Addresses

Obtain a list of sales order addresses.

- ID

- Sales Order ID

- Entity Type

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

- Created At

- Updated At

###### Get List of Sales Order Fulfillments

Obtain a list of sales order fulfillments.

- ID

- Sales Order ID

- Picked Date

- Status

- Conversion Rate

- Conversion Date

- Tracking Number

- Tracking URL

- Tracking Carrier

- Tracking Method

- Sales Order Fulfillment Rows

- Serial Numbers

- Packer ID

- Created At

- Updated At

###### Get List of Sales Order Rows

Obtain a list of sales order rows.

- ID

- Quantity

- Variant ID

- Tax Rate ID

- Price Per Unit

- Price Per Unit In Base Currency

- Total

- Total In Base Currency

- Attributes

- Batch Transactions

- Serial Numbers

- Linked Manufacturing Order ID

- Conversion Rate

- Conversion Date

- Created At

- Updated At

###### Get List of Sales Orders

Obtain a list of sales orders.

- ID

- Customer ID

- Order No

- Source

- Order Created Date

- Delivery Date

- Picked Date

- Location ID

- Status

- Currency

- Conversion Rate

- Conversion Date

- Invoicing Status

- Total

- Total In Base Currency

- Additional Info

- Customer Ref

- Sales Order Rows

- Ecommerce Order Type

- Ecommerce Store Name

- Ecommerce Order ID

- Product Availability

- Product Expected Date

- Ingredient Availability

- Ingredient Expected Date

- Production Status

- Created At

- Updated At

- Tracking Number

- Tracking Number URL

- Billing Address ID

- Shipping Address ID

- Addresses

###### Get List of Serial Numbers

Obtain a list of serial numbers.

- ID

- Transaction ID

- Serial Number

- Resource Type

- Resource ID

- Transaction Date

- Quantity Change

###### Get List of Shipping Fees

Obtain a list of shipping fees.

- ID

- Sales Order ID

- Description

- Amount

- Tax Rate ID

###### Get List of Stock Adjustments

Obtain a list of stock adjustments.

- ID

- Stock Adjustment Date

- Location ID

- Stock Adjustment Number

- Reason

- Additional Info

- Stock Adjustment Rows

- Created At

- Updated At

###### Get List of Stock Serial Numbers

Obtain a list of serial numbers with in-stock status which references to the linked resources.

- ID

- Serial Number

- In Stock

- Transactions

###### Get List of Stock Transfers

Obtain a list of stock transfers.

- ID

- Stock Transfer Number

- Source Location ID

- Target Location ID

- Transfer Date

- Additional Info

- Stock Transfer Rows

- Created At

- Updated At

###### Get List of Stocktake Rows

Obtain a list of stocktake rows.

- ID

- Variant ID

- Batch ID

- Stocktake ID

- Notes

- In Stock Quantity

- Counted Quantity

- Discrepancy Quantity

- Created At

- Updated At

- Deleted At

###### Get List of Stocktakes

Obtain a list of stocktakes.

- ID

- Stocktake Number

- Location ID

- Status

- Reason

- Additional Info

- Stocktake Created Date

- Started Date

- Completed Date

- Status Update In Progress

- Set Remaining Items As Counted

- Stock Adjustment ID

- Created At

- Updated At

- Deleted At

###### Get List of Storage Bins

Obtain a list of storage bins.

- ID

- Name

- Location ID

- Updated At

- Created At

- Deleted At

###### Get List of Supplier Addresses

Obtain a list of supplier addresses.

- ID

- Supplier ID

- Line 1

- Line 2

- City

- State

- Zip

- Country

- Updated At

- Created At

###### Get List of Suppliers

Obtain a list of suppliers.

- ID

- Name

- Email

- Comment

- Created At

- Updated At

###### Get List of Tax Rates

Obtain a list of tax rates.

- ID

- Name

- Rate

- Is Default Sales

- Is Default Purchases

- Display Name

- Created At

- Updated At

###### Get List of Variants

Obtain a list of variants.

- ID

- Product ID

- Material ID

- Sku

- Sales Price

- Purchase Price

- Config Attributes

- Type

- Created At

- Updated At

###### Get List of Variants with Negative Stock

Obtain a list of all variants with negative stock.

- Variant ID

- Location ID

- Latest Negative Stock Date

- Name

- Sku

- Category

###### Link Variant Default Storage Bins

Link variants with the default storage bins.

- ID

- Bin Name

- Variant ID

- Storage Bin ID

- Created At

- Updated At

- Deleted At

###### List All Additional Costs

Obtain a list of all additional costs you’ve previously created.

- ID

- Name

- Updated At

- Created At

- Deleted At

###### Receive Purchase Order

Grab all details about a purchase order.

###### Retrieve Current Factory

Grab all details about the current factory.

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Retrieve Location

Grab all details about a location.

- ID

- Name

- Legal Name

- Address ID

- Address

- Is Primary

- Sales Allowed

- Manufacturing Allowed

- Purchase Allowed

- Created At

- Updated At

- Deleted At

###### Retrieve Manufacturing Order

Grab all details about a manufacturing order.

- ID

- Status

- Order No

- Variant ID

- Planned Quantity

- Actual Quantity

- Batch Transactions

- Location ID

- Order Created Date

- Done Date

- Production Deadline Date

- Additional Info

- Is Linked To Sales Order

- Sales Order ID

- Sales Order Row ID

- Sales Order Delivery Deadline

- Ingredient Availability

- Total Cost

- Total Planned Time

- Total Actual Time

- Material Cost

- Subassemblies Cost

- Operations Cost

- Created At

- Updated At

- Deleted At

- Serial Numbers

###### Retrieve Manufacturing Order Operation Row

Grab all details about a manufacturing order operation row.

- ID

- Status

- Rank

- Manufacturing Order ID

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Assigned Operators

- Completed By Operators

- Active Operator ID

- Planned Time Per Unit

- Total Actual Time

- Planned Cost Per Unit

- Total Actual Cost

- Cost Per Hour

- Group Boundary

- Is Status Actionable

- Completed At

- Created At

- Updated At

- Deleted At

###### Retrieve Manufacturing Order Production

Grab all details about a manufacturing order production.

- ID

- Manufacturing Order ID

- Quantity

- Production Date

- Created At

- Updated At

- Deleted At

- Ingredients

- Operations

- Serial Numbers

###### Retrieve Manufacturing Order Recipe Row

Grab all details about a manufacturing order recipe row.

- ID

- Manufacturing Order ID

- Variant ID

- Notes

- Planned Quantity Per Unit

- Total Actual Quantity

- Ingredient Availability

- Ingredient Expected Date

- Batch Transactions

- Cost

- Created At

- Updated At

- Deleted At

###### Retrieve Material

Grab all details about a material.

- ID

- Name

- Uom

- Category Name

- Default Supplier ID

- Type

- Additional Info

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Tracked

- Variants

- Created At

- Updated At

- Configs

###### Retrieve Outsourced Purchase Order Recipe Row

Grab all details about an outsourced purchase order recipe row.

- ID

- Purchase Order ID

- Purchase Order Row ID

- Ingredient Variant ID

- Planned Quantity Per Unit

- Ingredient Availability

- Ingredient Expected Date

- Notes

- Batch Transactions

- Cost

- Created At

- Updated At

- Deleted At

###### Retrieve Product

Grab all details about a product.

- ID

- Name

- Uom

- Category Name

- Is Producible

- Default Supplier ID

- Is Purchasable

- Type

- Additional Info

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Tracked

- Serial Tracked

- Operations In Sequence

- Variants

- Created At

- Updated At

- Configs

###### Retrieve Purchase Order

Grab all details about a purchase order.

- ID

- Status

- Billing Status

- Last Document Status

- Order No

- Entity Type

- Supplier ID

- Currency

- Expected Arrival Date

- Order Created Date

- Additional Info

- Location ID

- Ingredient Availability

- Ingredient Expected Date

- Tracking Location ID

- Total

- Total In Base Currency

- Purchase Order Rows

- Created At

- Updated At

###### Retrieve Purchase Order Additional Cost Row

Grab all details about an existing purchase order additional cost row.

- ID

- Additional Cost ID

- Group ID

- Name

- Distribution Method

- Tax Rate ID

- Tax Rate

- Price

- Price In Base

- Currency

- Currency Conversion Rate

- Currency Conversion Rate Fix Date

- Updated At

- Created At

- Deleted At

###### Retrieve Purchase Order Row

Grab all details about a purchase order row.

- ID

- Quantity

- Variant ID

- Tax Rate ID

- Price Per Unit

- Purchase Uom

- Purchase Uom Conversion Rate

- Batch Transactions

- Total

- Total In Base Currency

- Conversion Rate

- Conversion Date

- Received Date

- Created At

- Updated At

###### Retrieve Sales Order

Grab all details about a sales order.

- ID

- Customer ID

- Order No

- Source

- Order Created Date

- Delivery Date

- Picked Date

- Location ID

- Status

- Currency

- Conversion Rate

- Conversion Date

- Invoicing Status

- Total

- Total In Base Currency

- Additional Info

- Customer Ref

- Sales Order Rows

- Ecommerce Order Type

- Ecommerce Store Name

- Ecommerce Order ID

- Product Availability

- Product Expected Date

- Ingredient Availability

- Ingredient Expected Date

- Production Status

- Created At

- Updated At

- Tracking Number

- Tracking Number URL

- Billing Address ID

- Shipping Address ID

- Addresses

###### Retrieve Sales Order Fulfillment

Grab all details about a sales order fulfillment.

- ID

- Sales Order ID

- Picked Date

- Status

- Conversion Rate

- Conversion Date

- Tracking Number

- Tracking URL

- Tracking Carrier

- Tracking Method

- Sales Order Fulfillment Rows

- Serial Numbers

- Packer ID

- Created At

- Updated At

###### Retrieve Sales Order Row

Grab all details about a sales order row.

- ID

- Quantity

- Variant ID

- Tax Rate ID

- Price Per Unit

- Price Per Unit In Base Currency

- Total

- Total In Base Currency

- Attributes

- Batch Transactions

- Serial Numbers

- Linked Manufacturing Order ID

- Conversion Rate

- Conversion Date

- Created At

- Updated At

###### Retrieve Shipping Fee

Grab all details about a shipping fee.

- ID

- Sales Order ID

- Description

- Amount

- Tax Rate ID

###### Retrieve Variant

Grab all details about a variant.

- ID

- Product ID

- Material ID

- Sku

- Sales Price

- Purchase Price

- Config Attributes

- Type

- Created At

- Updated At

###### Unassign Serial Numbers from Resource

Remove serial numbers from a resource.

###### Unlink Manufacturing Order from Sales Order Row

Unlink a manufacturing order from a particular sales order row.

###### Unlink Variant Default Storage Bins

Unlink variants from the default storage bins.

###### Update Customer

Modify a customer's information.

- Name

- First Name

- Last Name

- Company

- Email

- Phone

- Currency

- Comment

- Discount Rate

- Default Shipping ID

###### Update Customer Address

Modify a customer's address.

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Update Manufacturing Order

Modify a manufacturing order.

- Status

- Order No

- Variant ID

- Location ID

- Planned Quantity

- Actual Quantity

- Order Created Date

- Production Deadline Date

- Additional Info

- Done Date

- Batch Transactions

###### Update Manufacturing Order Operation Row

Modify a manufacturing order operation row.

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Planned Time Per Unit

- Total Actual Time

- Cost Per Hour

- Status

- Assigned Operators

- Completed By Operators

###### Update Manufacturing Order Production

Modify a manufacturing order production.

- Production Date

###### Update Manufacturing Order Production Ingredient

Update a specified manufacturing order production ingredient. Any fields not provided will be left unchanged. A manufacturing order production ingredient cannot be updated when the manufacturing order status is DONE.

- Batch Transactions

###### Update Manufacturing Order Recipe Row

Modify a manufacturing order recipe row.

- Variant ID

- Notes

- Planned Quantity Per Unit

- Total Actual Quantity

- Batch Transactions

###### Update Material

Modify a material.

- Name

- Uom

- Category Name

- Default Supplier ID

- Additional Info

- Batch Tracked

- Purchase Uom

- Purchase Uom Conversion Rate

- Configs

- Custom Field Collection ID

###### Update Outsourced Purchase Order Recipe Row

Modify an outsourced purchase order recipe row.

- Ingredient Variant ID

- Planned Quantity Per Unit

- Notes

- Batch Transactions

###### Update Product

Modify a product's details.

- Name

- Uom

- Category Name

- Is Producible

- Is Purchasable

- Default Supplier ID

- Additional Info

- Batch Tracked

- Operations In Sequence

- Serial Tracked

- Purchase Uom

- Purchase Uom Conversion Rate

- Configs

- Custom Field Collection ID

###### Update Product Operation Row

Modify a product's operation row.

- Operation ID

- Operation Name

- Resource ID

- Resource Name

- Cost Per Hour

- Planned Time Per Unit

###### Update Purchase Order

Modify a purchase order.

- Order No

- Supplier ID

- Currency

- Tracking Location ID

- Status

- Expected Arrival Date

- Order Created Date

- Location ID

- Additional Info

###### Update Purchase Order Additional Cost Row

Modify a purchase order's additional cost row.

- Additional Cost ID

- Tax Rate ID

- Price

- Distribution Method

###### Update Purchase Order Row

Modify a purchase order row.

- Quantity

- Variant ID

- Tax Rate ID

- Group ID

- Price Per Unit

- Purchase Uom Conversion Rate

- Purchase Uom

- Received Date

###### Update Recipe Row

Modify a recipe entry.

- Quantity

- Notes

- Ingredient Variant ID

###### Update Reorder Point

Modify the reorder point for a certain location and variant combination.

- Location ID

- Variant ID

- Value

###### Update Sales Order

Modify a sales order.

- Order No

- Customer ID

- Order Created Date

- Delivery Date

- Picked Date

- Location ID

- Status

- Currency

- Conversion Rate

- Conversion Date

- Additional Info

- Customer Ref

- Tracking Number

- Tracking Number URL

###### Update Sales Order Address

Modify a sales order's address.

- First Name

- Last Name

- Company

- Phone

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Update Sales Order Fulfillment

Modify sales order fulfillment's details.

- Picked Date

- Status

- Conversion Rate

- Packer ID

- Conversion Date

- Tracking Number

- Tracking URL

- Tracking Carrier

- Tracking Method

###### Update Sales Order Row

Modify a sales order row.

- Quantity

- Variant ID

- Tax Rate ID

- Price Per Unit

- Total Discount

- Batch Transactions

- Serial Number Transactions

- Attributes

###### Update Shipping Fee

Modify a shipping fee.

- Description

- Amount

- Tax Rate ID

###### Update Stock Adjustment

Modify a stock adjustment.

- Stock Adjustment Number

- Stock Adjustment Date

- Location ID

- Reason

- Additional Info

###### Update Stock Transfer

Modify a stock transfer.

- Stock Transfer Number

- Transfer Date

- Additional Info

###### Update Stocktake

Modify a stocktake.

- Stocktake Number

- Location ID

- Status

- Reason

- Additional Info

- Created Date

- Completed Date

- Set Remaining Items As Counted

###### Update Stocktake Row

Modify stocktake row information.

- Variant ID

- Batch ID

- Notes

- Counted Quantity

###### Update Storage Bin

Modify a storage bin.

- Bin Name

###### Update Supplier

Modify a supplier.

- Name

- Email

- Phone

- Currency

- Comment

###### Update Supplier Address

Modify a supplier's address.

- Line 1

- Line 2

- City

- State

- Zip

- Country

###### Update Variant

Modify a variant.

- Sku

- Sales Price

- Purchase Price

- Product ID

- Supplier Item Codes

- Internal Barcode

- Registered Barcode

- Material ID

- Config Attributes

- Custom Fields

[View all](/content/apps/katana/integrate/square#/index.html)

Not just software—partnership

## Expert support included

MESA includes hands-on support from automation experts who know how to get things done.

### Free workflow setup

We'll build your first workflow with you live. Most merchants walk away with automation saving 5+ hours/week.

### Fast response times

Average first response: Same day. Critical issues: Immediate escalation. Complex builds: 24-48 hours.

### Managed services available

Personalized workflow reviews, and quarterly check-ins to
identify new opportunities as your business grows.

### Real humans, always

Chat with real automation experts (not bots). Email support 9am-5pm PST.
Google Meet sessions for complex workflows.

## Integrate Katana with Square today.

Enjoy a 7-day free trial. Get your first workflow in minutes.

[Try MESA today →](/content/pricing/index.html)

MESA AI assistant

+×

Describe your task...

You've known what your store should be doing. Now it can. Describe the task then MESA handles it from there.
