1. WMS REST API Guide
  2. Bulk Create Item-Driven Cycle Count Tasks Directly

Bulk Create Item-Driven Cycle Count Tasks Directly

This API is used to create item-driven cycle count tasks directly in bulk, bypassing the need to execute a cycle count task creation template.

Note: This API supports creation of only item-driven cycle count tasks and does not support bulk creation of location-driven cycle count tasks.

URL

POST .../wms/lgfapi/v10/entity/location/cc_item_task/bulk_create

Request Parameters

Category Parameter/Field Name Type Required Description
parameters item_id_list Array (Integer) Yes Valid item IDs to create item-driven cycle count tasks. You can pass a single or multiple item IDs.
parameters facility_id Integer Conditional Facility context by id.
parameters facility_id__code String Conditional Facility context by code.
parameters company_id Integer Conditional Company context by id.
parameters company_id__code String Conditional Company context by code.
options location_id_list Array (Integer) No

Valid active or reserve location IDs to create item-driven count tasks. You can pass a single or multiple location IDs.

If location IDs are provided in the payload, the API creates item-driven cycle count tasks for the specified items at the specified locations. If location IDs are not provided, the API creates item-driven cycle count tasks for the specified items at all active and reserve locations where they exist.
options priority Integer Yes Task Priority.
options description String Yes Valid “CC-LOCN-BY-ITEM” task type description to create item-driven count tasks. You can pass only “CC-LOCN-BY-ITEM” task type description in the payload.
options commit_frequency Integer No

Frequency at which the changes are applied to each resource or group of resources being processed.

Supported values:

  • 0 (Default) = Roll back on first error.
  • 1 / Any integer > 0 = Commit per number of objects passed.
options max_num_of_tasks Integer No

Maximum number of item-driven cycle count tasks that can be created.

The API ignores this parameter when location IDs are passed in the payload.
Note:
  • Either facility_id or facility_id__code is mandatory to send.
  • Either company_id or company_id__code is mandatory to send.

Request Body

{
    "parameters": 
    {
        "item_id_list": [227989,227990,227988],
        "facility_id": "648",
        "company_id": "369"
    },
    "options": 
    {
        "location_id_list": [132873,136818,136798],
        "priority": 20,
        "description": "CC-LOCN-BY-ITEM",
        "commit_frequency": 1,
        "max_num_of_tasks": 1
    }
}

Sample Response

{
    "record_count": 3,
    "success_count": 3,
    "failure_count": 0,
    "data": null,
    "details": null
}