Zoho Inventory picklists API

openapi: 3.2.0
info:
  title: batches Picklists API
  description: Batches help you track inventory items by batch numbers, manufacturing dates, and expiration dates.
  contact: {}
  version: 1.0.0
servers:
- url: https://www.zohoapis.com/inventory/v1
  description: API Endpoint
tags:
- name: picklists
  description: Picklists Module
paths:
  /picklists:
    x-mcp-group:
    - Picklists
    get:
      tags:
      - picklists
      operationId: list_picklists
      summary: List Picklists
      description: Retrieve the list of all picklists in the organization.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: sort_column
        in: query
        description: Column by which the list is sorted.
        schema:
          type: string
          enum:
          - salesorder_number
          - picklist_number
          - date
          - created_time
          - last_modified_time
          - purchase_return_number
        example: date
      - name: sort_order
        in: query
        description: Sort order. `A` for ascending, `D` for descending.
        schema:
          type: string
          enum:
          - A
          - D
        example: D
      - name: search_text
        in: query
        description: Search text to filter picklists by name or number.
        schema:
          type: string
        example: Pick-00001
      - name: filter_by
        in: query
        description: 'Filter picklists by status. Example: `Status.All`, `Status.YetToStart`, `Status.InProgress`, `Status.OnHold`, `Status.Completed`, or `MissingAdvancedTrackingDetails`.'
        schema:
          type: string
        example: Status.InProgress
      - name: salesorder_number
        in: query
        description: Filter by sales order number.
        schema:
          type: string
        example: SO-00001
      - name: salesorder_number_startswith
        in: query
        description: Filter picklists where the associated sales order number starts with the given value.
        schema:
          type: string
        example: SO-0
      - name: salesorder_number_contains
        in: query
        description: Filter picklists where the associated sales order number contains the given value.
        schema:
          type: string
        example: '0001'
      - name: purchase_return_number
        in: query
        description: Filter by purchase return number.
        schema:
          type: string
        example: PR-00001
      - name: purchase_return_number_startswith
        in: query
        description: Filter picklists where the associated purchase return number starts with the given value.
        schema:
          type: string
        example: PR-0
      - name: purchase_return_number_contains
        in: query
        description: Filter picklists where the associated purchase return number contains the given value.
        schema:
          type: string
        example: '0001'
      - name: picklist_number
        in: query
        description: Filter by picklist number.
        schema:
          type: string
        example: Pick-00001
      - name: picklist_number_startswith
        in: query
        description: Filter picklists where the picklist number starts with the given value.
        schema:
          type: string
        example: Pick-0
      - name: picklist_number_contains
        in: query
        description: Filter picklists where the picklist number contains the given value.
        schema:
          type: string
        example: '0001'
      - name: item_id
        in: query
        description: Filter picklists that contain the specified item.
        schema:
          type: string
        example: '130426000000664040'
      - name: location_id
        in: query
        description: Filter picklists by location.
        schema:
          type: string
        example: '130426000000664030'
      - name: customer_id
        in: query
        description: Filter picklists by customer.
        schema:
          type: string
        example: '130426000000664050'
      - name: assignee_id
        in: query
        description: Filter picklists by the assigned user.
        schema:
          type: string
        example: '130426000000664060'
      - name: date
        in: query
        description: Filter picklists by a specific date (yyyy-mm-dd).
        schema:
          type: string
          format: date
        example: '2024-01-15'
      - name: date_start
        in: query
        description: Filter picklists from this start date (yyyy-mm-dd).
        schema:
          type: string
          format: date
        example: '2024-01-01'
      - name: date_end
        in: query
        description: Filter picklists up to this end date (yyyy-mm-dd).
        schema:
          type: string
          format: date
        example: '2024-01-31'
      - name: status
        in: query
        description: Filter picklists by status.
        schema:
          type: string
          enum:
          - yettostart
          - inprogress
          - onhold
          - completed
        example: inprogress
      - name: customview_id
        in: query
        description: ID of a custom view to apply.
        schema:
          type: string
        example: '130426000000664070'
      - name: page
        in: query
        description: Page number for pagination.
        schema:
          type: integer
          default: 1
        example: 1
      - name: per_page
        in: query
        description: Number of records per page.
        schema:
          type: integer
          default: 10
        example: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-picklists-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.READ
    post:
      tags:
      - picklists
      operationId: create_picklist
      summary: Create a Picklist
      description: Create a new picklist for picking items.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: ignore_auto_number_generation
        in: query
        description: Set to `true` to use a custom picklist number instead of the auto-generated one.
        schema:
          type: boolean
        example: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-a-picklist-request'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/picklist-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.CREATE
    delete:
      tags:
      - picklists
      operationId: bulk_delete_picklists
      summary: Bulk Delete Picklists
      description: Delete multiple picklists at once.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: picklist_ids
        in: query
        description: Comma-separated list of picklist IDs to delete. Maximum 200 IDs.
        required: true
        schema:
          type: string
        example: 130426000000810001,130426000000810002
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.DELETE
  /picklists/{picklist_id}:
    x-mcp-group:
    - Picklists
    parameters:
    - name: picklist_id
      in: path
      required: true
      description: Unique identifier of the picklist.
      schema:
        type: string
      example: '130426000000810001'
    get:
      tags:
      - picklists
      operationId: get_picklist
      summary: Get a Picklist
      description: Retrieve the details of an existing picklist.
      parameters:
      - name: print
        in: query
        description: Set to `true` to return print-friendly content.
        schema:
          type: boolean
        example: false
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/picklist-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.READ
    put:
      tags:
      - picklists
      operationId: update_picklist
      summary: Update a Picklist
      description: Update the details of an existing picklist.
      parameters:
      - name: ignore_auto_number_generation
        in: query
        description: Set to `true` to use a custom picklist number instead of the auto-generated one.
        schema:
          type: boolean
        example: false
      - $ref: '#/components/parameters/organization_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-a-picklist-request'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/picklist-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.UPDATE
    delete:
      tags:
      - picklists
      operationId: delete_picklist
      summary: Delete a Picklist
      description: Delete an existing picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.DELETE
  /picklists/{picklist_id}/setstatus:
    x-mcp-group:
    - Picklists
    parameters:
    - name: picklist_id
      in: path
      required: true
      description: Unique identifier of the picklist.
      schema:
        type: string
      example: '130426000000810001'
    post:
      tags:
      - picklists
      operationId: set_picklist_status
      summary: Set Status of a Picklist
      description: Update the status of a specific picklist.
      parameters:
      - name: status
        in: query
        required: true
        description: The new status to set for the picklist.
        schema:
          type: string
          enum:
          - yettostart
          - inprogress
          - onhold
          - completed
        example: completed
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.UPDATE
  /picklists/setstatus:
    x-mcp-group:
    - Picklists
    post:
      tags:
      - picklists
      operationId: bulk_set_picklist_status
      summary: Bulk Set Status of Picklists
      description: Update the status of multiple picklists at once.
      parameters:
      - name: picklist_ids
        in: query
        required: true
        description: Comma-separated list of picklist IDs. Maximum 25 IDs.
        schema:
          type: string
        example: 130426000000810001,130426000000810002
      - name: picklist_item_ids
        in: query
        description: Comma-separated list of picklist item IDs to update. Maximum 50 IDs.
        schema:
          type: string
        example: 130426000000810011,130426000000810012
      - name: status
        in: query
        required: true
        description: The new status to assign to the specified picklists.
        schema:
          type: string
          enum:
          - yettostart
          - inprogress
          - onhold
          - completed
        example: completed
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.UPDATE
  /picklists/{picklist_id}/comments:
    x-mcp-group:
    - Picklists
    parameters:
    - name: picklist_id
      in: path
      required: true
      description: Unique identifier of the picklist.
      schema:
        type: string
      example: '130426000000810001'
    post:
      tags:
      - picklists
      operationId: add_comment_to_picklist
      summary: Add a Comment to a Picklist
      description: Add a comment or note to an existing picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add-comment-request'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/comment-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.UPDATE
  /picklists/{picklist_id}/comments/{comment_id}:
    x-mcp-group:
    - Picklists
    parameters:
    - name: picklist_id
      in: path
      required: true
      description: Unique identifier of the picklist.
      schema:
        type: string
      example: '130426000000810001'
    - name: comment_id
      in: path
      required: true
      description: Unique identifier of the comment.
      schema:
        type: string
      example: '130426000000810021'
    delete:
      tags:
      - picklists
      operationId: delete_picklist_comment
      summary: Delete a Comment on a Picklist
      description: Delete a comment from an existing picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.DELETE
  /picklists/{picklist_id}/advancedtrackingdetails:
    x-mcp-group:
    - Picklists
    parameters:
    - name: picklist_id
      in: path
      required: true
      description: Unique identifier of the picklist.
      schema:
        type: string
      example: '130426000000810001'
    get:
      tags:
      - picklists
      operationId: get_picklist_advanced_tracking_details
      summary: Get Advanced Tracking Details for a Picklist
      description: Retrieve the serial number and batch tracking details for a picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced-tracking-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.READ
    put:
      tags:
      - picklists
      operationId: update_picklist_advanced_tracking_details
      summary: Update Advanced Tracking Details for a Picklist
      description: Update serial number and batch tracking details for items in a picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-advanced-tracking-request'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.picklists.UPDATE
  /picklists/searchsolineitems:
    x-mcp-group:
    - Picklists
    get:
      tags:
      - picklists
      operationId: search_so_line_items_for_picklist
      summary: Search Sales Order Line Items
      description: Search for sales order line items that can be added to a picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: customer_ids_in
        in: query
        description: Comma-separated list of customer IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000664050,130426000000664051
      - name: salesorder_ids_in
        in: query
        description: Comma-separated list of sales order IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000700001,130426000000700002
      - name: item_ids_in
        in: query
        description: Comma-separated list of item IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000664040,130426000000664041
      - name: location_id
        in: query
        description: Filter by location.
        schema:
          type: string
        example: '130426000000664030'
      - name: line_item_location_id
        in: query
        description: Filter by the location associated with the line item.
        schema:
          type: string
        example: '130426000000664031'
      - name: sort_column
        in: query
        description: Column by which the results are sorted.
        schema:
          type: string
          enum:
          - salesorder_number
          - name
          - sku
        example: salesorder_number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-so-line-items-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.salesorders.READ
  /picklists/searchso:
    x-mcp-group:
    - Picklists
    get:
      tags:
      - picklists
      operationId: search_sales_orders_for_picklist
      summary: Search Sales Orders
      description: Search for sales orders that can be used when creating a picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: customer_ids_in
        in: query
        description: Comma-separated list of customer IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000664050,130426000000664051
      - name: location_id
        in: query
        description: Filter by location.
        schema:
          type: string
        example: '130426000000664030'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-sales-orders-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.salesorders.READ
  /picklists/searchprlineitems:
    x-mcp-group:
    - Picklists
    get:
      tags:
      - picklists
      operationId: search_pr_line_items_for_picklist
      summary: Search Purchase Return Line Items
      description: Search for purchase return line items that can be added to a picklist.
      parameters:
      - $ref: '#/components/parameters/organization_id'
      - name: vendor_ids_in
        in: query
        description: Comma-separated list of vendor IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000664055,130426000000664056
      - name: purchasereturn_ids_in
        in: query
        description: Comma-separated list of purchase return IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000720001,130426000000720002
      - name: item_ids_in
        in: query
        description: Comma-separated list of item IDs to filter by. Maximum 50.
        schema:
          type: string
        example: 130426000000664040,130426000000664041
      - name: location_id
        in: query
        description: Filter by location.
        schema:
          type: string
        example: '130426000000664030'
      - name: line_item_location_id
        in: query
        description: Filter by the location associated with the line item.
        schema:
          type: string
        example: '130426000000664031'
      - name: sort_column
        in: query
        description: Column by which the results are sorted.
        schema:
          type: string
          enum:
          - purchasereturn_number
          - name
          - sku
        example: purchasereturn_number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-pr-line-items-response'
      deprecated: false
      security:
      - Zoho_Auth:
        - ZohoInventory.purchasereturns.READ
components:
  schemas:
    update-a-picklist-request:
      description: Request body for updating a picklist.
      type: object
      required:
      - date
      - line_items
      properties:
        picklist_number:
          description: Custom picklist number. Used when `ignore_auto_number_generation` is true.
          type: string
          maxLength: 50
          example: Pick-00001
        date:
          description: Date of the picklist (yyyy-mm-dd).
          type: string
          format: date
          example: '2024-01-15'
        location_id:
          description: ID of the location.
          type: string
          example: '130426000000664030'
        parent_entity:
          description: Type of the parent entity associated with the picklist.
          type: string
          enum:
          - salesorder
          - purchase_return
          example: salesorder
        group_by:
          description: Same semantics as on create; see `create-a-picklist-request.group_by`. Cannot be changed after creation; resend the original value.
          type: string
          enum:
          - none
          - item
          - sales_order
          example: none
        assignee_id:
          description: ID of the user to assign the picklist to.
          type: string
          example: '130426000000664060'
        notes:
          description: Internal notes for the picklist.
          type: string
          maxLength: 2000
          example: Fragile items - handle with care.
        line_items:
          description: Updated list of picklist line items. Shape depends on `group_by`. On update, pass `line_item_id` / `mapping_line_item_id` to update existing rows; omit them to add new rows. Rows not included are removed. Min 1, Max 1000.
          type: array
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/picklist-line-item-request'
        custom_fields:
          description: Custom field values for the picklist.
          type: array
          maxItems: 250
          items:
            type: object
            properties:
              label:
                description: Label of the custom field.
                type: string
                example: Zone
              value:
                description: Value for the custom field.
                type: string
                example: Zone A
    update-advanced-tracking-request:
      description: Request body for updating advanced tracking details of a picklist.
      type: object
      properties:
        line_items:
          description: Line items with updated tracking information.
          type: array
          items:
            type: object
            properties:
              line_item_id:
                description: ID of the line item to update.
                type: string
                example: '130426000000810011'
              serial_numbers:
                description: List of serial numbers for this line item. Maximum 10000.
                type: array
                maxItems: 10000
                items:
                  type: string
                example:
                - SN-001
                - SN-002
              batches:
                description: Batch details for this line item. Maximum 100.
                type: array
                maxItems: 100
                items:
                  type: object
                  properties:
                    batch_id:
                      description: Batch number identifier.
                      type: string
                      example: '130426000000810031'
                    out_quantity:
                      description: Quantity in this batch.
                      type: number
                      example: 5
    list-picklists-response:
      description: Response for listing picklists.
      type: object
      properties:
        code:
          type: integer
          readOnly: true
          example: 0
        message:
          type: string
          readOnly: true
          example: success
        picklists:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/picklist-object'
        page_context:
          type: object
          readOnly: true
          properties:
            page:
              type: integer
              readOnly: true
              example: 1
            per_page:
              type: integer
              readOnly: true
              example: 10
            has_more_page:
              type: boolean
              readOnly: true
              example: false
    picklist_id:
      description: Unique ID generated by the server for the picklist.
      type: string
      readOnly: true
      example: '130426000000810001'
    message-response:
      description: Generic success response with a message.
      type: object
      properties:
        code:
          type: integer
          readOnly: true
          example: 0
        message:
          type: string
          readOnly: true
          example: The picklist has been deleted.
    picklist_number:
      description: Unique number assigned to the picklist. Auto-generated unless overridden.
      type: string
      maxLength: 50
      example: Pick-00001
    picklist-detail-object:
      description: Detailed picklist record including line items and comments.
      allOf:
      - $ref: '#/components/schemas/picklist-object'
      - type: object
        properties:
          group_by:
            description: 'Grouping strategy used for the picklist items: `none`, `item`, or `sales_order`. See `create-a-picklist-request.group_by` for full semantics.'
            type: string
            readOnly: true
            example: none
          group_by_formatted:
            description: Formatted display label for the group-by value.
            type: string
            readOnly: true
            example: None
          total_picking_quantity:
            description: Total quantity of all items to be picked.
            type: number
            readOnly: true
            example: 25
          parent_entity:
            description: Type of the parent entity.
            type: string
            readOnly: true
            example: salesorder
          line_items:
            description: Line items in the picklist.
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/picklist-line-item'
          comments:
            description: Comments added to the picklist.
            type: array
            readOnly: true
            items:
              type: object
              properties:
                comment_id:
                  description: Unique ID of the comment.
                  type: string
                  readOnly: true
                  example: '130426000000810021'
                description:
                  description: Text content of the comment.
                  type: string
                  readOnly: true
                  example: Items checked and ready for dispatch.
                commented_by:
                  description: Name of the user who added the comment.
                  type: string
                  readOnly: true
                  example: John Doe
                date:
                  description: Date the comment was added.
                  type: string
                  readOnly: true
                  example: '2024-01-15'
          custom_fields:
            description: Custom field values for the picklist.
            type: array
            readOnly: true
            items:
              type: object
              properties:
                label:
                  type: string
                  readOnly: true
                  example: Zone
                value:
                  type: string
                  readOnly: true
                  example: Zone A
    add-comment-request:
      description: Request body for adding a comment to a picklist.
      type: object
      properties:
        description:
          description: Text content of the comment.
          type: string
          example: Items checked and ready for dispatch.
    search-pr-line-items-response:
      description: Response containing purchase return line items available for picklist creation.
      type: object
      properties:
        code:
          type: integer
          readOnly: true
          example: 0
        message:
          type: string
          readOnly: true
          example: success
        pr_line_items:
          type: array
          readOnly: true
          items:
            type: object
            properties:
              pr_line_item_id:
                description: Unique ID of the purchase return line item.
                type: string
                readOnly: true
                example: '130426000000720011'
              purchasereturn_id:
                description: ID of the purchase return.
                type: string
                readOnly: true
                example: '130426000000720001'
              purchasereturn_number:
                description: Number of the purchase return.
                type: string
                readOnly: true
                example: PR-00001
              item_id:
                description: ID of the item.
                type: string
                readOnly: true
                example: '130426000000664040'
              name:
                description: Name of the item.
                type: string
                readOnly: true
                example: Office Chair
              sku:
                description: SKU of the item.
                type: string
                readOnly: true
                example: CHAIR-001
              quantity:
                description: Return quantity.
                type: number
                readOnly: true
                example: 5
              quantity_picked:
                description: Quantity already picked.
                type: number
                readOnly: true
                example: 2
              quantity_to_be_picked:
                description: Quantity yet to be picked for this line item.
                type: number
                readOnly: true
                example: 3
              available_stock_for_picking:
                description: Stock currently available for picking. Returned only when `showAvailableStockForPicking` is enabled.
                type: number
                readOnly: true
                example: 25
              unit:
                description: Usage unit of the line item.
                type: string
                readOnly: true
                example: pcs
              base_unit:
                description: Base unit configured on the item.
                type: string
                readOnly: true
                example: pcs
              quantity_decimal_place:
                description: Number of decimal places used for quantity values on this line item.
                type: integer
                readOnly: true
                example: 2
              unit_conversion_id:
                description: ID of the unit conversion applied. Returned only when unit conversion is enabled.
                type: string
                readOnly: true
                example: '130426000000900001'
              conversion_rate:
   

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-inventory/refs/heads/main/openapi/zoho-inventory-picklists-api-openapi.yml