Zoho Inventory landedcosts 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 landedcosts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
6 operations
across 4 paths,
and defines 48 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.
6 operations4 paths48 schemas1 DELETE2 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.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 landedcosts API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are landed-cost-for-bill-response (19 properties), bill_details (13 properties), bill_line_item (10 properties), create-a-landed-cost-for-bill-request (8 properties). Each schema is shown below with its type and property counts.
currency_code
string
ISO code of the currency in which the landed cost is recorded.
create-bulk-landed-costs-response
object
2 properties
line_item_rate
number
Unit rate of the bill line item in the currency of the bill.
reference_entity_number
string
Number of the source transaction (for example, the bill number) from which the landed cost is recorded.
create-a-landed-cost-for-bill-response
object
3 properties
package_width
number
Width of the item package.
package_height
number
Height of the item package.
bill_line_item
object
10 properties
allocated_amount
number
Amount of the landed cost allocated to the bill line item, in the currency of the bill.
line_item_total
number
Sub-total of the bill line item in the currency of the bill.
reference_entity_id
string
Unique identifier of the source transaction (for example, the bill or self-billed invoice) from which the landed cost is recorded.
vendor_name
string
Display name of the vendor associated with the landed cost.
bill_item_id
string
Unique identifier of the bill line item that the landed cost is allocated to.
line_item_name
string
Name of the bill line item.
update-a-landed-cost-for-bill-request
object
landed-cost-for-bill-response
object
19 properties
package_details
object
Package dimensions and weight of the item, used when the allocation method is dimension or weight . Returned only when Zoho Inventory is enabled.
6 properties
account_id
string
Unique identifier of the expense account against which the landed cost is recorded.
bill_id
string
Unique identifier of the bill that the landed cost belongs to.
label_rate
number
Updated label (MRP) rate for the bill line item after the landed cost is applied. Returned only when MRP is enabled for the organization.
bill_number
string
Number of the bill that the landed cost belongs to.
weight_unit
string
Unit of measure for the package weight.
allocation_method
string
Method used to distribute the landed cost across the bill line items. Allowed values quantity , amount , dimension and weight .
sales_rate
number
Updated sales rate for the bill line item after the landed cost is applied.
price_precision
integer
Number of decimal places used to store the landed cost amounts.
bill_details
object
13 properties
update-a-landed-cost-for-bill-response
object
3 properties
reference_item_id
string
Unique identifier of the line item in the source transaction that represents the landed cost.
bulk-landed-cost-bill-allocation
object
3 properties
create-a-landed-cost-for-bill-request
object
8 properties1 required
delete-a-landed-cost-for-bill-response
object
2 properties
landed_cost_id
string
Unique identifier of the landed cost generated by the server.
currency_symbol
string
Symbol of the currency in which the landed cost is recorded.
get-a-landed-cost-for-bill-response
object
3 properties
currency_id
string
Unique identifier of the currency in which the landed cost is recorded.
dimension_unit
string
Unit of measure for the package dimensions.
get-bill-details-for-bulk-landed-cost-response
object
3 properties
account_name
string
Name of the expense account against which the landed cost is recorded.
cost_allocations_for_bill
array
Distribution of the landed cost across the line items of the bill. Each entry contains the bill line item identifier and the amount allocated to it.
create-bulk-landed-costs-request
object
7 properties
description
string
Description of the landed cost. Max length [100].
amount
number
Total landed cost amount in the currency of the bill.
cost_allocation_for_bill_request
object
4 properties
package_length
number
Length of the item package.
line_item_description
string
Description of the bill line item.
vendor_id
string
Unique identifier of the vendor associated with the landed cost.
line_item_quantity
number
Quantity of the bill line item.
package_weight
number
Weight of the item package.
Specification
The full machine-readable OpenAPI contract behind this narrative.
