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 salesreturns. 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.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
The identity and technical contract details declared by the specification.
notes
string
Notes for the current entity.
transaction_id
string
Unique ID generated by the server for the transaction. This is used as an identifier.
create-a-sales-return-request
object
6 properties
1 required
creditnote_id
string
Unique ID of the credit note generated by the server.
salesreturn-response
object
12 properties
status
string
Status of the credit note.
creditnotes
array
List of credit notes associated with a sales return.
label
string
Label of the Custom Field
transaction_type
string
Indicates the type of transaction.
salesreturn_number
string
Return Merchandise Authorisation (RMA) number of the Sales Return.
commented_by
string
Indicates the user who performed the action on the purchase order.
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.
create-a-sales-return-receive-request
object
3 properties
1 required
salesreturn_status
string
Status of the Sales Return.
location_name
string
Name of the location
rate
number
Price of the line item in an entity.
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…
quantity
number
The quantity that can be received for the line item.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
receive_status
string
Receive status of the Sales Return
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
update-a-sales-return-response
object
3 properties
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.
comments
array
History related to the Sales Return.
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
customer_id
string
Unique ID generated by the server for the customer.
name
string
Name of the line item.
retrieve-a-sales-return-response
object
3 properties
delete-a-sales-return-receive-response
object
2 properties
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
date
string
Date on which the entity was created.
customer_name
string
Name of the customer.
receive_id
string
Unique ID generated by the server for the Sales Return Receive. This is used as an identifier.
is_combo_product
boolean
Indicates whether the line item is a composite product.
salesreturn_id
string
Unique ID generated by the server for the Sales Return.
custom_fields
array
Custom fields for a salesreturn.
customfield_id
string
Unique ID of the custom field.
creditnote_number
string
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]
time
string
Indicates the time when the action was performed
total
number
Total amount on the credit note.
comment_type
string
Indicates the type of the action
non_receive_quantity
number
The quantity that cannot be received for the line item.
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
value
string
Value of the Custom Field
list-all-sales-returns-response
object
3 properties
refunded_amount
number
Total amount refunded to the customer.
create-a-sales-return-receive-response
object
3 properties
salesorder_id
string
Unique ID generated by the server for the Sales Order from which the Sales Return is created.
update-a-sales-return-request
object
6 properties
1 required
receive_number
string
Unique Sales Return Receive Number
comment_id
string
Unique ID generated by the server for the comment(history). This is used as an identifier.
location_id
string
Location ID
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
reason
string
The reason for raising a Sales Return.
refund_status
string
Refund status of the Sales Return
unit
string
Measurement unit of the line item.
delete-a-sales-return-response
object
2 properties
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.
operation_type
string
Type of operation performed on the transaction
description
string
Description of the line item.
create-a-sales-return-response
object
3 properties
salesorder_number
string
Unique sales order number for each sales order.
salesorder_item_id
string
Unique ID generated by the server for each line item in a sales order.
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
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.
line_items
array
The underlying items in a Sales Return
date_description
string
Indicates the time duration since the action was performed
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
