API - Corsair

Every zohoinventory.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Bills

create

bills.create Create a bill Risk: write

await corsair.zohoinventory.api.bills.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`vendor_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`bill`	`object`	No	—

bill full type

{
}

list

bills.list List bills Risk: read

await corsair.zohoinventory.api.bills.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`bills`	`object[]`	Yes	—
`page_context`	`object`	No	—

bills full type

{
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Composite Items

delete

compositeItems.delete Delete a composite item [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.compositeItems.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`composite_item_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

Contacts

create

contacts.create Create a contact Risk: write

await corsair.zohoinventory.api.contacts.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_name`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`contact`	`object`	No	—

contact full type

{
  contact_id: string,
  contact_name: string,
  company_name?: string,
  contact_type?: string,
  status?: string,
  email?: string,
  currency_code?: string,
  outstanding_receivable_amount?: number,
  outstanding_payable_amount?: number
}

createPerson

contacts.createPerson Create a contact person Risk: write

await corsair.zohoinventory.api.contacts.createPerson({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`contact_person`	`object`	No	—

contact_person full type

{
}

deactivate

contacts.deactivate Mark a contact inactive Risk: write

await corsair.zohoinventory.api.contacts.deactivate({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

delete

contacts.delete Delete a contact [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.contacts.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

deletePerson

contacts.deletePerson Delete a contact person [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.contacts.deletePerson({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_person_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

email

contacts.email Email a contact Risk: write

await corsair.zohoinventory.api.contacts.email({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—
`to_mail_ids`	`string[]`	No	—
`cc_mail_ids`	`string[]`	No	—
`subject`	`string`	No	—
`body`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

emailStatement

contacts.emailStatement Email a contact statement Risk: write

await corsair.zohoinventory.api.contacts.emailStatement({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—
`to_mail_ids`	`string[]`	No	—
`cc_mail_ids`	`string[]`	No	—
`subject`	`string`	No	—
`body`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

get

contacts.get Get a contact Risk: read

await corsair.zohoinventory.api.contacts.get({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`contact`	`object`	No	—

contact full type

{
  contact_id: string,
  contact_name: string,
  company_name?: string,
  contact_type?: string,
  status?: string,
  email?: string,
  currency_code?: string,
  outstanding_receivable_amount?: number,
  outstanding_payable_amount?: number
}

getAddress

contacts.getAddress Get a contact address Risk: read

await corsair.zohoinventory.api.contacts.getAddress({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`contact_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

list

contacts.list List contacts Risk: read

await corsair.zohoinventory.api.contacts.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—
`contact_type`	`customer \| vendor \| all`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`contacts`	`object[]`	Yes	—
`page_context`	`object`	No	—

contacts full type

{
  contact_id: string,
  contact_name: string,
  company_name?: string,
  contact_type?: string,
  status?: string,
  email?: string,
  currency_code?: string,
  outstanding_receivable_amount?: number,
  outstanding_payable_amount?: number
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Credit Notes

addComment

creditNotes.addComment Add a credit note comment Risk: write

await corsair.zohoinventory.api.creditNotes.addComment({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`creditnote_id`	`string`	Yes	—
`description`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`comment`	`object`	No	—

comment full type

{
}

applyCredits

creditNotes.applyCredits Apply credit note credits to invoices Risk: write

await corsair.zohoinventory.api.creditNotes.applyCredits({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`creditnote_id`	`string`	Yes	—
`invoices`	`object[]`	Yes	—

invoices full type

{
  invoice_id: string,
  amount_applied: number
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

create

creditNotes.create Create a credit note Risk: write

await corsair.zohoinventory.api.creditNotes.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`customer_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`creditnote`	`object`	No	—

creditnote full type

{
  creditnote_id: string,
  creditnote_number?: string,
  customer_id?: string,
  status?: string,
  total?: number,
  balance?: number
}

email

creditNotes.email Email a credit note Risk: write

await corsair.zohoinventory.api.creditNotes.email({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`creditnote_id`	`string`	Yes	—
`to_mail_ids`	`string[]`	No	—
`cc_mail_ids`	`string[]`	No	—
`subject`	`string`	No	—
`body`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

get

creditNotes.get Get a credit note Risk: read

await corsair.zohoinventory.api.creditNotes.get({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`creditnote_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`creditnote`	`object`	No	—

creditnote full type

{
  creditnote_id: string,
  creditnote_number?: string,
  customer_id?: string,
  status?: string,
  total?: number,
  balance?: number
}

getEmailContent

creditNotes.getEmailContent Get credit note email content Risk: read

await corsair.zohoinventory.api.creditNotes.getEmailContent({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`creditnote_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

list

creditNotes.list List credit notes Risk: read

await corsair.zohoinventory.api.creditNotes.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—
`status`	`string`	No	—
`customer_id`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`creditnotes`	`object[]`	Yes	—
`page_context`	`object`	No	—

creditnotes full type

{
  creditnote_id: string,
  creditnote_number?: string,
  customer_id?: string,
  status?: string,
  total?: number,
  balance?: number
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Currencies

list

currencies.list List currencies Risk: read

await corsair.zohoinventory.api.currencies.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`currencies`	`object[]`	Yes	—

currencies full type

{
}[]

Customer Payments

create

customerPayments.create Create a customer payment Risk: write

await corsair.zohoinventory.api.customerPayments.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`customer_id`	`string`	Yes	—
`amount`	`number`	Yes	—
`invoices`	`object[]`	No	—

invoices full type

{
  invoice_id: string,
  amount_applied?: number
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`payment`	`object`	No	—

payment full type

{
}

Invoices

addAttachment

invoices.addAttachment Upload an invoice attachment Risk: write

await corsair.zohoinventory.api.invoices.addAttachment({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—
`filename`	`string`	Yes	—
`content_base64`	`string`	Yes	—
`content_type`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

addComment

invoices.addComment Add an invoice comment Risk: write

await corsair.zohoinventory.api.invoices.addComment({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—
`description`	`string`	Yes	—
`show_comment_to_clients`	`boolean`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`comment`	`object`	No	—

comment full type

{
}

bulkEmail

invoices.bulkEmail Bulk email invoices Risk: write

await corsair.zohoinventory.api.invoices.bulkEmail({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_ids`	`string[]`	Yes	—
`contact_id`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

bulkExport

invoices.bulkExport Bulk export invoices as PDF Risk: read

await corsair.zohoinventory.api.invoices.bulkExport({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`content_type`	`string`	No	—
`content_base64`	`string`	No	—

bulkPrint

invoices.bulkPrint Bulk print invoices as PDF Risk: read

await corsair.zohoinventory.api.invoices.bulkPrint({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`content_type`	`string`	No	—
`content_base64`	`string`	No	—

cancelWriteOff

invoices.cancelWriteOff Cancel an invoice write-off Risk: write

await corsair.zohoinventory.api.invoices.cancelWriteOff({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

create

invoices.create Create an invoice Risk: write

await corsair.zohoinventory.api.invoices.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`customer_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`invoice`	`object`	No	—

invoice full type

{
  invoice_id: string,
  invoice_number?: string,
  customer_id?: string,
  customer_name?: string,
  status?: string,
  date?: string,
  total?: number,
  balance?: number
}

delete

invoices.delete Delete an invoice [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.invoices.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

deleteAttachment

invoices.deleteAttachment Delete an invoice attachment [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.invoices.deleteAttachment({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

deleteComment

invoices.deleteComment Delete an invoice comment [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.invoices.deleteComment({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—
`comment_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

disablePaymentReminder

invoices.disablePaymentReminder Disable invoice payment reminders Risk: write

await corsair.zohoinventory.api.invoices.disablePaymentReminder({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

email

invoices.email Email an invoice Risk: write

await corsair.zohoinventory.api.invoices.email({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—
`to_mail_ids`	`string[]`	No	—
`cc_mail_ids`	`string[]`	No	—
`subject`	`string`	No	—
`body`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

enablePaymentReminder

invoices.enablePaymentReminder Enable invoice payment reminders Risk: write

await corsair.zohoinventory.api.invoices.enablePaymentReminder({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

list

invoices.list List invoices Risk: read

await corsair.zohoinventory.api.invoices.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`invoices`	`object[]`	Yes	—
`page_context`	`object`	No	—

invoices full type

{
  invoice_id: string,
  invoice_number?: string,
  customer_id?: string,
  customer_name?: string,
  status?: string,
  date?: string,
  total?: number,
  balance?: number
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

listPayments

invoices.listPayments List payments on an invoice Risk: read

await corsair.zohoinventory.api.invoices.listPayments({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`invoice_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`payments`	`object[]`	Yes	—

payments full type

{
}[]

Item Groups

create

itemGroups.create Create an item group Risk: write

await corsair.zohoinventory.api.itemGroups.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`group_name`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`itemgroup`	`object`	No	—

itemgroup full type

{
}

deactivate

itemGroups.deactivate Mark an item group inactive Risk: write

await corsair.zohoinventory.api.itemGroups.deactivate({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`itemgroup_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

delete

itemGroups.delete Delete an item group [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.itemGroups.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`itemgroup_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

list

itemGroups.list List item groups Risk: read

await corsair.zohoinventory.api.itemGroups.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`itemgroups`	`object[]`	Yes	—
`page_context`	`object`	No	—

itemgroups full type

{
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Items

create

items.create Create an inventory item Risk: write

await corsair.zohoinventory.api.items.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`item`	`object`	No	—

item full type

{
  item_id: string,
  name: string,
  sku?: string,
  status?: string,
  rate?: number,
  purchase_rate?: number,
  item_type?: string,
  product_type?: string,
  stock_on_hand?: number,
  available_stock?: number,
  description?: string
}

deactivate

items.deactivate Mark an item inactive Risk: write

await corsair.zohoinventory.api.items.deactivate({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`item_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

delete

items.delete Delete an item [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.items.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`item_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

deleteImage

items.deleteImage Delete an item image [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.items.deleteImage({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`item_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

list

items.list List inventory items Risk: read

await corsair.zohoinventory.api.items.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`items`	`object[]`	Yes	—
`page_context`	`object`	No	—

items full type

{
  item_id: string,
  name: string,
  sku?: string,
  status?: string,
  rate?: number,
  purchase_rate?: number,
  item_type?: string,
  product_type?: string,
  stock_on_hand?: number,
  available_stock?: number,
  description?: string
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Organizations

list

organizations.list List organizations the user can access Risk: read

await corsair.zohoinventory.api.organizations.list({});

Input: empty object Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`organizations`	`object[]`	Yes	—

organizations full type

{
  organization_id: string,
  name: string,
  is_default_org?: boolean,
  contact_name?: string,
  email?: string,
  is_org_active?: boolean,
  currency_code?: string,
  currency_id?: string,
  currency_symbol?: string,
  time_zone?: string,
  language_code?: string,
  fiscal_year_start_month?: number
}[]

Packages

bulkPrint

packages.bulkPrint Bulk print package slips as PDF Risk: read

await corsair.zohoinventory.api.packages.bulkPrint({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`package_ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`content_type`	`string`	No	—
`content_base64`	`string`	No	—

create

packages.create Create a package for a sales order Risk: write

await corsair.zohoinventory.api.packages.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`salesorder_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`package`	`object`	No	—

package full type

{
}

delete

packages.delete Delete a package [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.packages.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`package_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

Purchase Orders

create

purchaseOrders.create Create a purchase order Risk: write

await corsair.zohoinventory.api.purchaseOrders.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`vendor_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`purchaseorder`	`object`	No	—

purchaseorder full type

{
}

list

purchaseOrders.list List purchase orders Risk: read

await corsair.zohoinventory.api.purchaseOrders.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`purchaseorders`	`object[]`	Yes	—
`page_context`	`object`	No	—

purchaseorders full type

{
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Sales Orders

bulkDelete

salesOrders.bulkDelete Bulk delete sales orders [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.salesOrders.bulkDelete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`salesorder_ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

create

salesOrders.create Create a sales order Risk: write

await corsair.zohoinventory.api.salesOrders.create({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`customer_id`	`string`	Yes	—
`line_items`	`object[]`	No	—

line_items full type

{
  item_id?: string,
  name?: string,
  description?: string,
  rate?: number,
  quantity?: number,
  unit?: string,
  tax_id?: string
}[]

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`salesorder`	`object`	No	—

salesorder full type

{
  salesorder_id: string,
  salesorder_number?: string,
  customer_id?: string,
  customer_name?: string,
  status?: string,
  date?: string,
  total?: number
}

delete

salesOrders.delete Delete a sales order [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.zohoinventory.api.salesOrders.delete({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`salesorder_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—

get

salesOrders.get Get a sales order Risk: read

await corsair.zohoinventory.api.salesOrders.get({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`salesorder_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`salesorder`	`object`	No	—

salesorder full type

{
  salesorder_id: string,
  salesorder_number?: string,
  customer_id?: string,
  customer_name?: string,
  status?: string,
  date?: string,
  total?: number
}

list

salesOrders.list List sales orders Risk: read

await corsair.zohoinventory.api.salesOrders.list({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).
`page`	`number`	No	—
`per_page`	`number`	No	—
`search_text`	`string`	No	—

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`salesorders`	`object[]`	Yes	—
`page_context`	`object`	No	—

salesorders full type

{
  salesorder_id: string,
  salesorder_number?: string,
  customer_id?: string,
  customer_name?: string,
  status?: string,
  date?: string,
  total?: number
}[]

page_context full type

{
  page?: number,
  per_page?: number,
  has_more_page?: boolean,
  report_name?: string,
  applied_filter?: string,
  sort_column?: string,
  sort_order?: string
}

Users

getCurrent

users.getCurrent Get the current authenticated user Risk: read

await corsair.zohoinventory.api.users.getCurrent({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Zoho Inventory organization_id (query on every org-scoped call).

Output

Name	Type	Required	Description
`code`	`number`	No	—
`message`	`string`	No	—
`user`	`object`	No	—

user full type

{
  user_id: string,
  name: string,
  email: string,
  user_role?: string,
  status?: string,
  is_current_user?: boolean
}

​Bills

​create

​list

​Composite Items

​delete

​Contacts

​create

​createPerson

​deactivate

​delete

​deletePerson

​email

​emailStatement

​get

​getAddress

​list

​Credit Notes

​addComment

​applyCredits

​create

​email

​get

​getEmailContent

​list

​Currencies

​list

​Customer Payments

​create

​Invoices

​addAttachment

​addComment

​bulkEmail

​bulkExport

​bulkPrint

​cancelWriteOff

​create

​delete

​deleteAttachment

​deleteComment

​disablePaymentReminder

​email

​enablePaymentReminder

​list

​listPayments

​Item Groups

​create

​deactivate

​delete

​list

​Items

​create

​deactivate

​delete

​deleteImage

​list

​Organizations

​list

​Packages

​bulkPrint

​create

​delete

​Purchase Orders

​create

​list

​Sales Orders

​bulkDelete

​create

​delete

​get

​list

​Users

​getCurrent

Bills

create

list

Composite Items

delete

Contacts

create

createPerson

deactivate

delete

deletePerson

email

emailStatement

get

getAddress

list

Credit Notes

addComment

applyCredits

create

email

get

getEmailContent

list

Currencies

list

Customer Payments

create

Invoices

addAttachment

addComment

bulkEmail

bulkExport

bulkPrint

cancelWriteOff

create

delete

deleteAttachment

deleteComment

disablePaymentReminder

email

enablePaymentReminder

list

listPayments

Item Groups

create

deactivate

delete

list

Items

create

deactivate

delete

deleteImage

list

Organizations

list

Packages

bulkPrint

create

delete

Purchase Orders

create

list

Sales Orders

bulkDelete

create

delete

get

list

Users

getCurrent