Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory putaways API

Putaways Module

Zoho Inventory putaways 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 putaways. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 10 operations across 6 paths, and defines 22 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.

10 operations 6 paths 22 schemas 2 DELETE5 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 putaways API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 10

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

putaways 10

Putaways Module

POST
/putaways
Create a putaway
create_putaway 2 params body → 200
GET
/putaways
List all putaways
list_putaways 11 params → 200
GET
/putaways/{putaway_id}
Retrieve a putaway
get_putaway 4 params → 200
PUT
/putaways/{putaway_id}
Update a putaway
update_putaway 3 params body → 200
DELETE
/putaways/{putaway_id}
Delete a putaway
delete_putaway 2 params → 200
GET
/putaways/{putaway_id}/comments
List comments for a putaway
list_putaway_comments 2 params → 200
POST
/putaways/{putaway_id}/attachment
Attach files to a putaway
add_putaway_attachment 2 params body → 200
GET
/putaways/{putaway_id}/documents/{document_id}
Download a putaway document
get_putaway_document 6 params → 200
DELETE
/putaways/{putaway_id}/documents/{document_id}
Remove an attachment from a putaway
delete_putaway_document 4 params → 200
GET
/settings/putaways
Get putaway auto number generation settings
get_putaway_settings 1 param → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are putaway-line-item-response (15 properties), putaway-response (14 properties), putaway-line-batch-node (11 properties), putaway-list-row (11 properties). Each schema is shown below with its type and property counts.

create-a-putaway-response
object
3 properties
page_context
object
Pagination and list context for the current result set.
7 properties
list-putaway-comments-response
object
3 properties
get-a-putaway-response
object
3 properties
delete-a-putaway-response
object
Returned when a putaway is deleted.
2 properties
putaway-attachment-response
object
3 properties
putaway-line-serial-node
object
Serial number row for a putaway line when serial tracking is enabled.
3 properties
list-putaways-response
object
4 properties
get-putaway-settings-response
object
3 properties
putaway-response
object
14 properties
putaway-line-item-request
object
7 properties 2 required
putaway-document-attachment
object
File attached to a putaway (DocumentDetailsForEntity).
5 properties
update-a-putaway-request
putaway-settings
object
3 properties
update-a-putaway-response
putaway-list-row
object
11 properties
delete-a-putaway-document-response
object
Returned when a document is removed from a putaway.
2 properties
putaway-line-item-response
object
15 properties
putaway-line-storage-node
object
Storage-bin allocation for a putaway line when storage tracking is enabled.
2 properties
putaway-comment
object
10 properties
putaway-line-batch-node
object
One batch allocation on a putaway line when batch tracking is enabled (see server BatchNumberCreate / BatchNumberEdit).
11 properties
create-a-putaway-request
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-putaways-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