How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory salesreturns API

SalesReturns Module

Zoho Inventory salesreturns API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Sales Returns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 7 operations across 4 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

7 operations 4 paths 67 schemas 2 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory salesreturns API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

salesreturns 7

SalesReturns Module

POST
/salesreturns
Create a Sales Return
create_sales_return 2 params body → 201
GET
/salesreturns
List all Sales Returns
list_sales_returns 3 params → 200
PUT
/salesreturns/{salesreturn_id}
Update a Sales Return
update_sales_return 3 params body → 200
GET
/salesreturns/{salesreturn_id}
Retrieve a Sales Return
get_sales_return 2 params → 200
DELETE
/salesreturns/{salesreturn_id}
Delete a Sales Return
delete_sales_return 2 params → 200
POST
/salesreturnreceives
Create a Sales Return Receive
create_sales_return_receive 2 params body → 201
DELETE
/salesreturnreceives/{salesreturnreceive_id}
Delete a Sales Return Receive
delete_sales_return_receive 2 params → 200

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are salesreturn-response (12 properties), update-a-sales-return-request (6 properties), create-a-sales-return-request (6 properties), create-a-sales-return-receive-response (3 properties). Each schema is shown below with its type and property counts.

create-a-sales-return-receive-request
object
3 properties 1 required
salesreturn_status
string
Status of the Sales Return.
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
refund_status
string
Refund status of the Sales Return
mapped_items_receive
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
salesorder_id
string
Unique ID generated by the server for the Sales Order from which the Sales Return is created.
update-a-sales-return-response
object
3 properties
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
creditnote_id
string
Unique ID of the credit note generated by the server.
comment_id
string
Unique ID generated by the server for the comment(history). This is used as an identifier.
commented_by
string
Indicates the user who performed the action on the purchase order.
receive_id
string
Unique ID generated by the server for the Sales Return Receive. This is used as an identifier.
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
non_receive_quantity
number
The quantity that cannot be received for the line item.
creditnotes
array
List of credit notes associated with a sales return.
description
string
Description of the line item.
transaction_id
string
Unique ID generated by the server for the transaction. This is used as an identifier.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
location_id
string
Location ID
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
mapped_items_update
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
status
string
Status of the credit note.
label
string
Label of the Custom Field
customer_id
string
Unique ID generated by the server for the customer.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
customer_name
string
Name of the customer.
total
number
Total amount on the credit note.
comment_type
string
Indicates the type of the action
receive_status
string
Receive status of the Sales Return
delete-a-sales-return-response
object
2 properties
quantity
number
The quantity that can be received for the line item.
location_name
string
Name of the location
batches
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
reason
string
The reason for raising a Sales Return.
line_items
array
The underlying items in a Sales Return
date
string
Date on which the entity was created.
notes
string
Notes for the current entity.
create-a-sales-return-request
object
6 properties 1 required
salesreturn_number
string
Return Merchandise Authorisation (RMA) number of the Sales Return.
delete-a-sales-return-receive-response
object
2 properties
creditnote_number
string
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]
value
string
Value of the Custom Field
customfield_id
string
Unique ID of the custom field.
unit
string
Measurement unit of the line item.
rate
number
Price of the line item in an entity.
salesreturn-response
object
12 properties
salesorder_number
string
Unique sales order number for each sales order.
create-a-sales-return-receive-response
object
3 properties
receive_number
string
Unique Sales Return Receive Number
update-a-sales-return-request
object
6 properties 1 required
is_combo_product
boolean
Indicates whether the line item is a composite product.
retrieve-a-sales-return-response
object
3 properties
operation_type
string
Type of operation performed on the transaction
comments
array
History related to the Sales Return.
refunded_amount
number
Total amount refunded to the customer.
create-a-sales-return-response
object
3 properties
salesreturn_id
string
Unique ID generated by the server for the Sales Return.
transaction_type
string
Indicates the type of transaction.
date_description
string
Indicates the time duration since the action was performed
mapped_items_create
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
list-all-sales-returns-response
object
3 properties
time
string
Indicates the time when the action was performed
salesorder_item_id
string
Unique ID generated by the server for each line item in a sales order.
custom_fields
array
Custom fields for a salesreturn.
mapped_items
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-salesreturns-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
Where this information came from

This is an independent, third-party profile of Zoho Inventory salesreturns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.